Struct easy_args::ArgSpecBuilder

pub struct ArgSpecBuilder { /* fields omitted */ }

Builder type for ArgSpec.

Implementations

impl ArgSpecBuilder

pub fn done(self) -> Result<ArgSpec>

Completes building the ArgSpec. Returns [Ok(ArgSpec)] if no build errors and [Err(Error)] if otherwise.

Example

use easy_args::ArgSpec;

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

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

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

Example

use easy_args::arg_spec;

let args = arg_spec! {
    fullscreen: bool,
    vsync: bool,
    username: String
}
.parse()
.unwrap();

pub fn arg(self, name: impl Into<String>, ty: ArgType) -> ArgSpecBuilder

Adds an argument the the ArgSpec with a given name and type.

Example

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .arg("flag", ArgType::Boolean)
    .done()
    .unwrap();

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

Adds a boolean argument to the ArgSpec.

Example

use easy_args::{ArgSpec, ArgType};

 let spec = ArgSpec::build()
    .boolean("vsync")
    .done()
    .unwrap();
 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

use easy_args::{ArgSpec, ArgType};

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

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

Adds a u64 argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

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

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

Adds an f64 argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .float("gravity")
    .done()
    .unwrap();
assert_eq!(spec.has_arg("gravity", ArgType::Float), true);

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

Adds a String argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

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

pub fn boolean_array(
    self,
    size: usize,
    name: impl Into<String>
) -> ArgSpecBuilder

Adds a boolean array argument to the ArgSpec.

Example

use easy_args::{ArgSpec, ArgType};

 let spec = ArgSpec::build()
    .boolean_array(2, "bools")
    .done()
    .unwrap();
 assert_eq!(spec.has_arg("bools", ArgType::BooleanArray(2)), true);

pub fn integer_array(
    self,
    size: usize,
    name: impl Into<String>
) -> ArgSpecBuilder

Adds an i64 array argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .integer_array(3, "position")
    .done()
    .unwrap();
assert_eq!(spec.has_arg("position", ArgType::IntegerArray(3)), true);

pub fn uinteger_array(
    self,
    size: usize,
    name: impl Into<String>
) -> ArgSpecBuilder

Adds a u64 array argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .uinteger_array(2, "size")
    .done()
    .unwrap();
assert_eq!(spec.has_arg("size", ArgType::UIntegerArray(2)), true);

pub fn float_array(self, size: usize, name: impl Into<String>) -> ArgSpecBuilder

Adds a f64 array argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .float_array(3, "position")
    .done()
    .unwrap();
assert_eq!(spec.has_arg("position", ArgType::FloatArray(2)), true);

pub fn string_array(
    self,
    size: usize,
    name: impl Into<String>
) -> ArgSpecBuilder

Adds a String array argument to the ArgSpec.

Exmaple

use easy_args::{ArgSpec, ArgType};

let spec = ArgSpec::build()
    .string_array(2, "name")
    .done()
    .unwrap();
assert_eq!(spec.has_arg("name", ArgType::StringArray(2)), true);