Struct Cli 

pub struct Cli { /* private fields */ }

Implementations

impl Cli

pub fn crates(&self) -> &Vec<PathBuf>

One or more crate directories to scan. If none, current dir is used.

pub fn include_tests(&self) -> &bool

Include test code?

pub fn single_test_name(&self) -> &Option<String>

Single out one test block by name.

pub fn omit_private(&self) -> &bool

Omit private functions?

pub fn omit_bodies(&self) -> &bool

Omit function bodies?

pub fn single_function_name(&self) -> &Option<String>

Only include one function body by name.

pub fn excluded_files(&self) -> &Vec<String>

Exclude specified files (by relative path).

pub fn exclude_main_file(&self) -> &bool

Exclude main file (like src/lib.rs)?

pub fn remove_doc_comments(&self) -> &bool

Remove doc comments from functions

Trait Implementations

impl Debug for Cli

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StructOpt for Cli

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.