Struct dinero::CommonOpts

pub struct CommonOpts {

    pub input_file: PathBuf,
    pub depth: Option<usize>,
    pub query: Vec<String>,
    pub real: bool,
    pub begin: Option<NaiveDate>,
    pub end: Option<NaiveDate>,
    pub no_balance_check: bool,
    pub exchange: Option<String>,
    pub convert: Option<String>,
    pub date_format: String,
    pub strict: bool,
    pub pedantic: bool,
    pub collapse: bool,
    pub related: bool,
    // some fields omitted
}

Command line options

Fields

input_file: PathBuf

Input file

depth: Option<usize>

Depth

query: Vec<String>

The pattern to look for

real: bool

Use only real postings rather than real and virtual

begin: Option<NaiveDate>

end: Option<NaiveDate>

no_balance_check: bool

Ignore balance assertions

exchange: Option<String>

Display the report in the selected currency

convert: Option<String>

Add a conversion to the selected currency in the output

date_format: String

Date format

strict: bool

Accounts, tags or commodities not previously declared will cause warnings.

pedantic: bool

Accounts, tags or commodities not previously declared will cause errors.

collapse: bool

Whether to collapse postings from the same account in the same transaction

related: bool

Show the other postings in the transaction

Trait Implementations

impl Clone for CommonOpts

fn clone(&self) -> CommonOpts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommonOpts

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

Formats the value using the given formatter.

impl StructOpt for CommonOpts

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

Returns clap::App corresponding to the struct.

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.

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.

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.

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.

impl TryFrom<&'_ CommonOpts> for Ledger

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(options: &CommonOpts) -> Result<Self, Self::Error>

Performs the conversion.