Struct quickmd::input::Options

pub struct Options {
    pub debug: bool,
    pub input_file: PathBuf,
    pub watch: bool,
    pub output_dir: Option<PathBuf>,
}

Command-line options. Managed by StructOpt.

Fields

debug: bool

Activates debug logging

input_file: PathBuf

Markdown file to render. Use "-" to read markdown from STDIN (implies --no-watch)

watch: bool

Disables watching file for changes

output_dir: Option<PathBuf>

Builds output HTML and other assets in the given directory instead of in a tempdir. Will be created if it doesn't exist. Not deleted on application exit.

Implementations

impl Options

pub fn init_logging(&self)

Start logging based on input flags.

With --debug:

• All logs
• Timestamps
• Module path context

Otherwise:

• Only warnings and errors
• Minimal formatting

Trait Implementations

impl Debug for Options

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

Formats the value using the given formatter.

impl StructOpt for Options

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

Returns clap::App corresponding to the struct.

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

pub fn from_args() -> Self

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.

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

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.

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

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

impl StructOptInternal for Options

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

pub fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>