Module gflags::custom

Interface for defining your own flag data type.

A list of the built-in supported flag types may be found in the list of impls of the Value trait. The gflags library is extensible to custom data types by providing your own impl of that trait.

Examples

use gflags::custom::{Arg, Error, Result, Value};

gflags::define! {
    --color <WHEN>: Color = Color::Auto
}

enum Color {
    Never,
    Always,
    Auto,
}

impl Value for Color {
    fn parse(arg: Arg) -> Result<Self> {
        match arg.get_str() {
            "never" => Ok(Color::Never),
            "always" => Ok(Color::Always),
            "auto" => Ok(Color::Auto),
            _ => Err(Error::new("invalid color")),
        }
    }
}

Structs

Arg

Raw argument value given for a non-boolean flag.

Error

Error returned when parsing a flag value fails.

Traits

Value

Types that may be the data type of a flag.

Type Definitions

Result

Result of parsing a flag value.