Struct mdsh::cli::Opt

pub struct Opt {
    pub input: FileArg,
    pub output: Option<FileArg>,
    pub work_dir: Option<PathBuf>,
    pub frozen: bool,
    pub clean: bool,
}

Markdown shell pre-processor. Never let your READMEs and tutorials get out of sync again.

Exits non-zero if a sub-command failed.

Fields

input: FileArg

Path to the markdown file. - for stdin.

output: Option<FileArg>

Path to the output file, - for stdout [defaults to updating the input file in-place].

work_dir: Option<PathBuf>

Directory to execute the scripts under [defaults to the input file’s directory].

frozen: bool

Fail if the output is different from the input. Useful for CI.

Using --frozen, you can guarantee that developers update documentation when they make a change. Just add mdsh --frozen as a check to your continuous integration setup.

clean: bool

Remove all generated blocks.

Trait Implementations

impl Debug for Opt

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

Formats the value using the given formatter.

impl StructOpt for Opt

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

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: 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
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

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