Struct bookkeeping::Move

pub struct Move<T: Metadata> { /* fields omitted */ }

Represents a move of a Sum of Units from one account to another.

Implementations

impl<T: Metadata> Move<T>

pub fn set_metadata(&self, meta: T::Move)

Sets the metadata value on this entity.

pub fn get_metadata(&self) -> Ref<'_, T::Move>

Gets the metadata value on this entity.

Internally, the field that holds metadata is an std::cell::RefCell. Ideally, I would not like to leak this detail through the public API by returning std::cell::Ref here. Yet, I'm not sure what the alternative is. Perhaps returning a clone?

impl<T: Metadata> Move<T>

pub fn new(
    debit_account: &Rc<Account<T>>,
    credit_account: &Rc<Account<T>>,
    sum: &Sum<T>,
    meta: T::Move
) -> Rc<Self>

Creates a new move.

Panics

• debit_account and credit_account are in different books.
• debit_account and credit_account are the same.
• Some Unit in the Sum is not in the same book as the accounts.

pub fn balance_in(
    &self,
    account: &Rc<Account<T>>,
    cmp: impl Fn(&T::Move, &T::Move) -> Ordering
) -> Balance<T>

Calculates the balance that is the result of this move in an account according to a provided order of moves.

Panics

• account is not debit nor credit in this move.

Trait Implementations

impl<T: Debug + Metadata> Debug for Move<T> where
    T::Move: Debug, 

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

Formats the value using the given formatter.

impl<T: Metadata> Eq for Move<T>

impl<T: Metadata> Ord for Move<T>

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: Metadata> PartialEq<Move<T>> for Move<T>

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Metadata> PartialOrd<Move<T>> for Move<T>

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.