Struct bookkeeping::Book

pub struct Book<Unit, SumNumber, AccountExtra, TransactionExtra, MoveExtra> where
    Unit: Ord,  { /* fields omitted */ }

Represents a book.

Implementations

impl<Unit, SumNumber, AccountExtra, TransactionExtra, MoveExtra> Book<Unit, SumNumber, AccountExtra, TransactionExtra, MoveExtra> where
    Unit: Ord, 

pub fn insert_account(&mut self, extra: AccountExtra) -> AccountKey

Inserts an account.

pub fn insert_transaction(
    &mut self,
    transaction_index: TransactionIndex,
    extra: TransactionExtra
) where
    Unit: Ord, 

Creates a transaction and inserts it at an index.

Panics

• transaction_index out of bounds.

pub fn insert_move(
    &mut self,
    transaction_index: TransactionIndex,
    move_index: MoveIndex,
    debit_account_key: AccountKey,
    credit_account_key: AccountKey,
    sum: Sum<Unit, SumNumber>,
    extra: MoveExtra
) where
    Unit: Ord, 

Creates a new move and inserts it into a transaction at an index.

Panics

• transaction_index out of bounds.
• move_index out of bounds.
• Some of debit_account_key and credit_account_key are not in the book.
• debit_account_key and credit_account_key are equal.
• Some unit keys in the sum are not in the book.

pub fn get_account(&self, account_key: AccountKey) -> &AccountExtra

Gets an account using a key.

Panics

• account_key is not in the book.

pub fn accounts(&self) -> impl Iterator<Item = (AccountKey, &AccountExtra)>

Gets an iterator of existing accounts in order of creation.

pub fn transactions(
    &self
) -> impl Iterator<Item = (TransactionIndex, &Transaction<Unit, SumNumber, TransactionExtra, MoveExtra>)>

Gets an iterator of existing transactions in their order.

pub fn set_account(&mut self, account_key: AccountKey, extra: AccountExtra)

Sets an existing account.

Panics

• account_key is not in the book.

pub fn set_transaction_extra(
    &mut self,
    transaction_index: TransactionIndex,
    extra: TransactionExtra
)

Sets extra data for a transaction.

Panics

• transaction_index out of bounds.

pub fn set_move_extra(
    &mut self,
    transaction_index: TransactionIndex,
    move_index: MoveIndex,
    extra: MoveExtra
) where
    Unit: Ord, 

Sets extra data for a move.

Panics

• transaction_index out of bounds.
• move_index out of bounds.

pub fn account_balance_at_transaction<'a, BalanceNumber>(
    &'a self,
    account_key: AccountKey,
    transaction_index: TransactionIndex
) -> Balance<Unit, BalanceNumber> where
    Unit: Ord + Clone,
    BalanceNumber: Default + Sub<Output = BalanceNumber> + Add<Output = BalanceNumber> + Clone,
    SumNumber: Clone + Into<BalanceNumber>, 

Calculates the balance of an account at a provided transaction.

Providing an out of bounds transaction_index is undefined behavior.

Panics

• account_key is not in the book.

pub fn remove_transaction(&mut self, transaction_index: TransactionIndex)

Removes an existing transaction from the book.

Panics

• transaction_index out of bounds.

pub fn remove_move(
    &mut self,
    transaction_index: TransactionIndex,
    move_index: MoveIndex
) where
    Unit: Ord, 

Removes an existing move from the book.

Panics

• transaction_index out of bounds.
• move_index out of bounds.

pub fn set_move_sum(
    &mut self,
    transaction_index: TransactionIndex,
    move_index: MoveIndex,
    sum: Sum<Unit, SumNumber>
) where
    Unit: Ord, 

Sets the sum of an existing move.

Panics

• transaction_index out of bounds.
• move_index out of bounds.

pub fn set_move_side(
    &mut self,
    transaction_index: TransactionIndex,
    move_index: MoveIndex,
    side: Side,
    account_key: AccountKey
) where
    Unit: Ord, 

Sets the account for one of the sides of an existing move.

Panics

• transaction_index out of bounds.
• move_index out of bounds.
• account_key is not in the book.
• side is same as other side.

Trait Implementations

impl<Unit, SumNumber, AccountExtra, TransactionExtra, MoveExtra> Default for Book<Unit, SumNumber, AccountExtra, TransactionExtra, MoveExtra> where
    Unit: Ord, 

pub fn default() -> Self

Returns the "default value" for a type.