Struct GameOptions

pub struct GameOptions {
    pub speed: Speed,
    pub head_symbol: String,
    pub body_symbol: String,
    pub snake_length: u16,
    pub life: u16,
    pub nb_of_fruit: u16,
    pub uncaps_fps: bool,
    pub classic_mode: bool,
    pub save: bool,
    pub load: bool,
}

Structure holding all the configuration parameters for the game

Fields

speed: Speed

Speed of the snake (Slow, Normal, Fast, Tremendous) Derives ValueEnum on the enum Speed and enforces the type clap::ValueEnum, which automatically handles possible values and displays them in the help message. Now, clap enforces valid inputs without requiring a manual FromStr implementation.

head_symbol: String

Snake symbol (emoji or character) Defines short value because doublon, as short and long are by default based on the name of the variable

body_symbol: String

Snake trail symbol (emoji or character)

snake_length: u16

Initial length of the snake

life: u16

Number of lives

nb_of_fruit: u16

Number of fruits in the game

uncaps_fps: bool

Caps to 60 FPS or not

classic_mode: bool

Classic game with only growing snake

save: bool

Save game parameters

load: bool

Load game parameters

Implementations

impl GameOptions

pub fn initial_position() -> Position

Returns the initial snake position

pub fn get_speed(&self) -> Speed

Gets the current speed setting

pub fn save_to_toml<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Save the current parameters to a TOML file

Errors

Returns an error if the file cannot be created or written to.

Panics

Panics if the game parameters cannot be serialized to TOML.

pub fn load_from_toml<P: AsRef<Path>>(path: P) -> Result<Self>

Load parameters from a TOML file

Errors

Returns an error if the file cannot be opened or read.

Panics

Panic if the file contents cannot be deserialized as valid TOML.

pub fn validate_and_adapt(&mut self)

Trait Implementations

impl Args for GameOptions

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for GameOptions

fn clone(&self) -> GameOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for GameOptions

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for GameOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GameOptions

fn default() -> GameOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GameOptions

where GameOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for GameOptions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for GameOptions

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for GameOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.