Struct EntryPoint 

pub struct EntryPoint { /* private fields */ }

The command line, and what it means.

It lives in the library rather than in main so the mapping from arguments to a run – which root, which command, which overrides – is something a test can call. main is left with nothing but an exit code to return.

Implementations

impl EntryPoint

pub fn run(args: Vec<String>) -> ExitCode

Parse args, run what they ask for, and report the outcome.

Taking the arguments rather than reading argv is what lets a test call this at all; main passes the real ones.

pub fn root(&self) -> PathBuf

The root to analyse: what --path said, or where the shell is.

pub fn command(&self) -> Command

The command to run. Naming none means report.

pub fn overrides(&self) -> CliOverrides

What the flags override in the loaded configuration.

The three booleans become Some(true) or None rather than Some(false): a flag that was not passed has no opinion, and a config file that turned the behaviour on must not be switched off by its absence.

pub const fn format(&self) -> OutputFormat

The output format asked for.

Trait Implementations

impl Args for EntryPoint

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for EntryPoint

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl FromArgMatches for EntryPoint

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for EntryPoint

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.