var searchIndex = {};
searchIndex["args"] = {"doc":"A dead simple implementation of command line argument parsing and validation\nbuilt on top of the [getopts](https://crates.io/crates/getopts) crate.","items":[[3,"ArgsError","args","An implementation of `Error` which may or may not include a scope and/or usage message.",null,null],[3,"Args","","A dead simple implementation of command line argument parsing and validation.",null,null],[0,"traits","","A module containing traits designed to provide args-based convenience methods.",null,null],[8,"HasArgs","args::traits","A trait designed to bind associated convenience methods to a struct.",null,null],[10,"args","","Returns a mutable references to an associated `Args` struct.",0,{"inputs":[],"output":{"name":"args"}}],[11,"full_usage","","Generates a combination of the short and verbose usage messages.",0,{"inputs":[],"output":{"name":"string"}}],[11,"parse","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[{"name":"c"}],"output":{"name":"result"}}],[11,"parse_from_cli","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"result"}}],[11,"short_usage","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"string"}}],[11,"usage","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"string"}}],[8,"HasParsedArgs","","A trait designed to bind parsed arguments and instance methods to a struct.",null,null],[10,"parsed_args","","Returns a references to the parsed `Args` struct.",1,null],[11,"has_value","","Acts as a convenience method for calling the `Args` implementation.",1,null],[11,"validated_value_of","","Acts as a convenience method for calling the `Args` implementation.",1,null],[11,"value_of","","Acts as a convenience method for calling the `Args` implementation.",1,null],[0,"validations","args","A module containing enums and traits associated with argument validation.",null,null],[3,"OrderValidation","args::validations","An implementation of `Validation` which tests whether or not a value adheres\nto the provided `order` and `bound`. It should be noted that the type of\n`bound`, `O`, must implement `Clone`, `Display` **and** `PartialOrd`.",null,null],[4,"Order","","The relationship to use when validating an `OrderValidation`.",null,null],[13,"GreaterThan","","Represents a strictly greater than relationship.",2,null],[13,"GreaterThanOrEqual","","Represents a greater than relationship that allows equality.",2,null],[13,"LessThan","","Represents a strictly less than relationship.",2,null],[13,"LessThanOrEqual","","Represents a less than relationship that allows equality.",2,null],[8,"Validation","","A trait designed to provide validation for command line argument parsing.",null,null],[16,"T","","The `type` (e.g. `i32`, `String`, etc.) to which the validation is applied.",3,null],[10,"error","","Returns an `ArgsError` describing the invalid state for the provided `value`.",3,null],[10,"is_valid","","Returns a `bool` indicating if the `Validation` passes for the provided `value`.",3,null],[11,"is_invalid","","Returns a `bool` indicating if the `Validation` fails for the provided `value`.",3,null],[11,"compare","","Compares the provided `value` to the provided `bound`",2,null],[11,"fmt","","",2,null],[11,"new","","Creates a new `OrderValidation` with the provided `order` and `bound`.",4,{"inputs":[{"name":"order"},{"name":"o"}],"output":{"name":"ordervalidation"}}],[11,"error","","",4,null],[11,"is_valid","","",4,null],[11,"new","args","Creates a new `ArgsError` with the provided `scope` and `msg`.\nIf `scope` is an empty string (i.e. `""`) it will be ignored.",5,{"inputs":[{"name":"str"},{"name":"str"}],"output":{"name":"argserror"}}],[11,"new_with_usage","","Creates a new `ArgsError` with the provided `scope`, `msg` and `usage` message.\nIf either `scope` or `usage` are an empty string (i.e. `""`) they will be ignored.",5,{"inputs":[{"name":"str"},{"name":"str"},{"name":"str"}],"output":{"name":"argserror"}}],[11,"fmt","","",5,null],[11,"fmt","","",5,null],[11,"description","","",5,null],[11,"new","","Creates an empty set of command line options.",6,{"inputs":[{"name":"str"},{"name":"str"}],"output":{"name":"args"}}],[11,"flag","","Registers an optional flag argument that does not take an argument and defaults to false.",6,null],[11,"full_usage","","Generates a combination of the short and verbose usage messages.",6,null],[11,"has_options","","Returns a `bool` indicating whether or not any options are registered.",6,null],[11,"has_value","","Returns a `bool` indicating whether or not a argument is present.",6,null],[11,"iter","","Returns an iterator visiting all key-value pairs in alphabetical order.",6,null],[11,"option","","Registers an option explicitly.",6,null],[11,"parse","","Parses arguments according to the registered options.",6,null],[11,"parse_from_cli","","Parses arguments directly from the command line according to the registered options.",6,null],[11,"short_usage","","Generates a one-line usage summary from the registered options.",6,null],[11,"usage","","Generates a verbose usage summary from the registered options.",6,null],[11,"validated_value_of","","Retrieves the value of the `Opt` identified by `opt_name`, casts it to\nthe type specified by `T` and then runs all provided `Validation`s.",6,null],[11,"value_of","","Retrieves the value for the `Opt` identified by `opt_name` and casts it to\nthe type specified by `T`.",6,null],[11,"values_of","","Retrieves a vector of values for the `Opt` identified by `opt_name` and\ncasts each of them to the type specified by `T`.",6,null],[11,"fmt","","",6,null],[11,"full_usage","args::traits","Generates a combination of the short and verbose usage messages.",0,{"inputs":[],"output":{"name":"string"}}],[11,"parse","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[{"name":"c"}],"output":{"name":"result"}}],[11,"parse_from_cli","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"result"}}],[11,"short_usage","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"string"}}],[11,"usage","","Acts as a convenience method for calling the associated `Args` implementation.",0,{"inputs":[],"output":{"name":"string"}}],[11,"has_value","","Acts as a convenience method for calling the `Args` implementation.",1,null],[11,"validated_value_of","","Acts as a convenience method for calling the `Args` implementation.",1,null],[11,"value_of","","Acts as a convenience method for calling the `Args` implementation.",1,null]],"paths":[[8,"HasArgs"],[8,"HasParsedArgs"],[4,"Order"],[8,"Validation"],[3,"OrderValidation"],[3,"ArgsError"],[3,"Args"]]};
initSearch(searchIndex);