Struct GameOption 

#[non_exhaustive]
pub struct GameOption {
    pub flag: &'static str,
    pub value: Option<&'static str>,
    pub help: &'static str,
}

An option a game adds to frame-png. Build it with GameOption::new (ADR-0039).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flag: &'static str

The flag (--light).

value: Option<&'static str>

What its value is called in the usage text (NAME), if it takes one.

help: &'static str

What it does, for the usage text (lines after the first are indented under it).

Implementations

impl GameOption

pub const fn new(flag: &'static str, help: &'static str) -> Self

The flag flag, explained by help, taking no value (with_value names one).

pub const fn with_value(self, value: Option<&'static str>) -> Self

The option with its value called value in the usage text.

Trait Implementations

impl Clone for GameOption

fn clone(&self) -> GameOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GameOption

impl Debug for GameOption

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

Formats the value using the given formatter.

impl Eq for GameOption

impl From<&GameOption> for StartOption

fn from(option: &GameOption) -> Self

Converts to this type from the input type.

impl PartialEq for GameOption

fn eq(&self, other: &GameOption) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GameOption