Struct Transaction 

pub struct Transaction { /* private fields */ }

A generic financial transaction.

Implementations

impl Transaction

pub const fn new( id: TransactionId, amount: Amount, transaction_date: TransactionDate, direction: TransactionDirection, ) -> Transaction

Creates a pending transaction from required fields.

pub const fn id(&self) -> &TransactionId

Returns the transaction identifier.

pub const fn amount(&self) -> Amount

Returns the transaction amount.

pub const fn transaction_date(&self) -> &TransactionDate

Returns the transaction date.

pub const fn posted_date(&self) -> Option<&PostedDate>

Returns the posted date.

pub const fn effective_date(&self) -> Option<&EffectiveDate>

Returns the effective date.

pub const fn status(&self) -> TransactionStatus

Returns the transaction status.

pub const fn direction(&self) -> TransactionDirection

Returns the transaction direction.

pub fn description(&self) -> Option<&str>

Returns the optional transaction description.

pub const fn with_status(self, status: TransactionStatus) -> Transaction

Sets the transaction status.

pub fn with_posted_date(self, posted_date: PostedDate) -> Transaction

Sets the posted date.

pub fn with_effective_date(self, effective_date: EffectiveDate) -> Transaction

Sets the effective date.

pub fn with_description( self, description: impl AsRef<str>, ) -> Result<Transaction, TransactionError>

Sets a non-empty transaction description.

Errors

Returns [TransactionError::EmptyDescription] when the trimmed input is empty.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl PartialEq for Transaction

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Transaction

impl StructuralPartialEq for Transaction