Struct cargo_doc2readme::Args

pub(crate) struct Args {
    pub(crate) manifest_path: Option<PathBuf>,
    pub(crate) out: PathBuf,
    pub(crate) template: PathBuf,
}

Fields

manifest_path: Option<PathBuf>

Path to Cargo.toml.

out: PathBuf

Output File.

template: PathBuf

Template File. This is processed by Tera. Look at the source code for cargo-doc2readme for an example.

Trait Implementations

impl Clap for Args

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.

impl FromArgMatches for Args

fn from_arg_matches(matches: &ArgMatches) -> Self

It’s common to have an “application context” struct (sometimes called config) that represents all the normalized values after being processed by the CLI.

impl IntoApp for Args

fn into_app<'b>() -> App<'b>

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs