Struct arkham::Context

pub struct Context {
    pub cmd: Command,
    // some fields omitted
}

Fields

cmd: Command

Implementations

impl Context

pub fn flag(&self, name: &str) -> bool

Checks for the existance of a flag

pub fn get_value(&self, name: &str) -> Option<ContextValue>

Returns the value of an option if one exists

pub fn get_string(&self, name: &str) -> Option<String>

Returns a string for the field if it is a string

pub fn get_int(&self, name: &str) -> Option<i64>

Returns a i64 for the field if it is an integer

pub fn get_float(&self, name: &str) -> Option<f64>

Returns a f64 for the field if it is a float

pub fn get_bool(&self, name: &str) -> Option<bool>

Returns a f64 for the field if it is a float

pub fn display_help(&self)

Can be used to display the automatic help message for the current command.