Struct Ledger 

pub struct Ledger {
    pub budgets: Vec<Budget>,
    pub presets: Vec<Preset>,
    pub lines: Vec<Line>,
    pub reserves: Vec<Reserve>,
    pub covers: Vec<Cover>,
    pub mail_rules: Vec<MailRule>,
    pub bank_accounts: Vec<BankAccount>,
    pub splits: Vec<Split>,
    pub assignments: Vec<Assignment>,
}

Everything in sioul-budgets.toml.

Fields

budgets: Vec<Budget>

presets: Vec<Preset>

lines: Vec<Line>

reserves: Vec<Reserve>

covers: Vec<Cover>

mail_rules: Vec<MailRule>

bank_accounts: Vec<BankAccount>

splits: Vec<Split>

assignments: Vec<Assignment>

Implementations

impl Ledger

pub fn with_bank(&self, bank: &Bank, looked: &Words) -> Ledger

The ledger with its bank accounts’ movements as lines, done on their day, for the budgets to count (budget::Ledger::status): the presets each stands for are named (#3 for one without an id). Kept in memory only; the budget file is not written.

impl Ledger

pub fn load_with_bank(root: &Path, looked: &Words) -> Result<Ledger, String>

The budget file at the root of a notes folder, with its bank accounts’ movements counted (with_bank) when it declares some.

impl Ledger

pub fn load(root: &Path) -> Result<Ledger, String>

Reads sioul-budgets.toml at the root of a notes folder.

pub fn load_file(path: &Path) -> Result<Ledger, String>

Reads a budget file anywhere.

pub fn budget_title<'a>(&'a self, id: &'a str) -> &'a str

A budget’s title by id, else the id.

pub fn reserve_title<'a>(&'a self, id: &'a str) -> &'a str

A reserve’s title by id, else the id.

pub fn status(&self, budget: &Budget, today: Date) -> BudgetStatus

How a budget’s current period is going.

fn opening(&self, budget: &Budget, start: Date, today: Date) -> Money

The balance carried into the period starting on start: everything since the budget’s start, as it happened (transfers from reserves included as lines).

fn status_for( &self, budget: &Budget, start: Date, end: Date, today: Date, opening: Money, ) -> BudgetStatus

fn planned_later(&self, budget: &Budget, end: Date) -> Money

What the planned lines of the coming year will take, after end (as a positive amount).

fn flows(&self, budget: &Budget, from: Date, to: Date, today: Date) -> Vec<Flow>

Every flow of a budget between two dates: lines and preset occurrences. A line that stands for a preset counts through it (see occurrence).

fn absorbing(&self, line: &Line) -> Option<&Preset>

The preset occurrence a line stands for, if its preset falls in the line’s period.

fn occurrence(&self, preset: &Preset, date: Date, today: Date) -> Vec<Flow>

One occurrence of a preset, with the lines standing for it in its period. Without any, a preset dated up to today is assumed done. With some, a fixed preset is replaced by them (the real amount); an estimate is an envelope they are spent from, and what remains of it is still to come.

pub fn reserve_status(&self, reserve: &Reserve, today: Date) -> ReserveStatus

A reserve’s balance and its planned draws.

fn planned_draws(&self, reserve: &Reserve, today: Date, until: Date) -> Money

What will leave a reserve after today, up to until: planned transfers, and the covers of every budget period ending in that time.

fn covers_ending(&self, budget: &Budget, today: Date, until: Date) -> Money

The reserve transfers of a budget’s periods, from the current one to those ending by until; each period opens with the last one’s balance after its transfer.

impl Ledger

fn unscheduled_history( &self, budget: &Budget, start: Date, today: Date, ) -> Vec<Money>

Unscheduled movements of each past period (the newest twelve with any).

pub fn pace(&self, budget: &Budget, today: Date) -> Pace

The current period at its pace (see Pace).

impl Ledger

pub fn movements( &self, budget: &Budget, from: Date, to: Date, today: Date, ) -> Vec<Movement>

Every movement of a budget between two dates, oldest first: its lines and its recurring movements.

pub fn balance_series( &self, budget: &Budget, from: Date, to: Date, step: &str, today: Date, ) -> Vec<Point>

The balance at the end of each step (“day”, “week”, “month”, “year”) from from to to, planned movements included.

Trait Implementations

impl Clone for Ledger

fn clone(&self) -> Ledger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ledger

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

Formats the value using the given formatter.

impl Default for Ledger

fn default() -> Ledger

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ledger

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.