Enum Commands

pub enum Commands {
    New {
        name: String,
        currency: String,
    },
    Spend {
        account: String,
        amount: f64,
        description: String,
        tags: HashSet<String>,
    },
    Income {
        account: String,
        amount: f64,
        description: String,
        tags: HashSet<String>,
    },
    Balance {
        account: Option<String>,
        from: Option<Date>,
        to: Option<Date>,
        chart: bool,
        script: Option<PathBuf>,
    },
}

Variants

New

Create a new account. Fails if the account already exists.

Fields

name: String

Name of the new account.

currency: String

Name of the new account.

Spend

Add a spending transaction.

Fields

account: String

The account to add the transaction to.

amount: f64

amount of currency associated to the transaction.

description: String

Description of the transaction.

tags: HashSet<String>

Tags to classify the transaction. Example: –tags=house,family,expenses

Income

Add an income transaction.

Fields

account: String

The account to add the transaction to.

amount: f64

amount of currency associated to the transaction.

description: String

Description of the transaction.

tags: HashSet<String>

Tags to classify the transaction. Example: –tags=house,family,expenses

Balance

Display the total balance of accounts.

Fields

account: Option<String>

Name of the account to display the balance from. If not specified, will aggregate all balances from the accounts in the --accounts directory.

from: Option<Date>

Sums balances starting from this date.

to: Option<Date>

Sums balances to this date.

chart: bool

Write the transactions to a svg chart.

script: Option<PathBuf>

Use a rhai script to format the output.

Implementations

impl Commands

pub fn run(self, accounts_path: &str) -> Result<(), Error>

Trait Implementations

impl FromArgMatches for Commands

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand