Struct easy_args::spec::ArgSpecBuilder

pub struct ArgSpecBuilder { /* fields omitted */ }

Builder type for ArgSpec.

Implementations

impl ArgSpecBuilder

pub fn done(self) -> ArgSpec

Completes building the ArgSpec and returns it.

Example

let spec = ArgSpec::build()
    .unsigned_integer("chickens")
    .done();

pub fn parse(self) -> Result<Args>

Little Wrapper function that will complete building the ArgSpec and immediately call [parse()].

Example

let args = ArgSpec::build()
    .boolean("fullscreen")
    .boolean("vsync")
    .string("username")
    .parse()?;

pub fn boolean(self, name: impl Into<String>) -> ArgSpecBuilder

Adds a boolean argument to the ArgSpec.

Example

 let spec = ArgSpec::build().boolean("vsync").done();
 assert_eq!(spec.has_arg("vsync", ArgType::Boolean), true);

pub fn integer(self, name: impl Into<String>) -> ArgSpecBuilder

Adds an i64 argument to the ArgSpec.

Exmaple

let spec = ArgSpec::build().integer("num-bananas").done();
assert_eq!(spec.has_arg("num-bananas", ArgType::Integer), true);

pub fn unsigned_integer(self, name: impl Into<String>) -> ArgSpecBuilder

Adds a u64 argument to the ArgSpec.

Exmaple

let spec = ArgSpec::build().unsigned_integer("screen-width").done();
assert_eq!(spec.has_arg("screen-width", ArgType::UInteger), true);

pub fn string(self, name: impl Into<String>) -> ArgSpecBuilder

Adds a String argument to the ArgSpec.

Exmaple

let spec = ArgSpec::build().string("MOD").done();
assert_eq!(spec.has_arg("MOD", ArgType::String), true);