Struct Args 

pub struct Args {
    pub paths: Vec<String>,
    pub write: bool,
    pub check: bool,
    pub stdin: bool,
    pub width: usize,
    pub wrap: WrapMode,
    pub ordered_list: OrderedListMode,
    pub excludes: Vec<String>,
    pub no_default_excludes: bool,
}

Fields

paths: Vec<String>

Files or directories to format (supports glob patterns, use - for stdin)

write: bool

Write formatted output to file in-place

check: bool

Check if files are formatted (exit with 1 if not)

stdin: bool

Read from stdin

width: usize

Line width for wrapping (default: 80)

wrap: WrapMode

How to wrap prose: always (reflow to width), never (one line per paragraph), preserve (keep as-is)

ordered_list: OrderedListMode

How to number ordered lists: ascending (1, 2, 3), one (all 1.)

excludes: Vec<String>

Additional directories to exclude (node_modules, target, .git, vendor, dist, build are excluded by default)

no_default_excludes: bool

Don’t exclude any directories by default

Implementations

impl Args

pub fn get_input_sources(&self) -> Result<Vec<InputSource>, String>

Resolve input paths to a list of markdown files or stdin

Trait Implementations

impl Args for Args

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 Args

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 Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 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.

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.