Struct CmdArgs 

pub struct CmdArgs {
    pub config: Option<Vec<PathBuf>>,
    pub input: Vec<PathBuf>,
    pub workspace: Vec<PathBuf>,
    pub exclude_pattern: Option<Vec<String>>,
    pub include_pattern: Option<Vec<String>>,
    pub output_format: Format,
    pub format: Option<Format>,
    pub output: OutputDestination,
    pub override_template: Option<PathBuf>,
    pub site_name: Option<String>,
    pub mixin: Option<PathBuf>,
    pub verbose: bool,
}

Fields

config: Option<Vec<PathBuf>>

Configuration file paths. If not provided, both “.emmyrc.json” and “.luarc.json” will be searched in the workspace directory

input: Vec<PathBuf>

Deprecated, use [WORKSPACE] instead

workspace: Vec<PathBuf>

Path to the workspace directory

exclude_pattern: Option<Vec<String>>

Comma separated list of exclude patterns Patterns must follow glob syntax Exclude patterns take precedence over include patterns

include_pattern: Option<Vec<String>>

Comma separated list of include patterns Patterns must follow glob syntax

output_format: Format

Specify output format

format: Option<Format>

Deprecated, use –output-format instead

output: OutputDestination

Specify output destination (can be stdout when output_format is json)

override_template: Option<PathBuf>

The path of the override template

site_name: Option<String>

mixin: Option<PathBuf>

A directory whose contents are merged with the generated Markdown files. For example, to override docs/index.md, create a folder called “docs” in your mixin folder and create a file called “index.md” inside it.

verbose: bool

Verbose output

Trait Implementations

impl Args for CmdArgs

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 CmdArgs

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 Debug for CmdArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CmdArgs

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 CmdArgs

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.