Enum HoldStatus 

#[non_exhaustive]
pub enum HoldStatus<const P: u8 = 2> {
    Open,
    Posted {
        by: EntryId,
        amount: Amount<P>,
    },
    Voided {
        by: EntryId,
    },
    Expired {
        by: EntryId,
    },
}

Where a hold stands.

use doubleentry::{EntryId, HoldStatus, amount};

let by = EntryId::from_bytes([7; 16]);
let posted: HoldStatus = HoldStatus::Posted { by, amount: amount!("60.00") };
assert_eq!(posted.resolved_by(), Some(by));
assert_eq!(posted.to_string(), format!("posted 60.00 by {by}"));
assert_eq!(HoldStatus::<2>::Open.resolved_by(), None);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Open

Not resolved yet: the amount is reserved.

Posted

Posted by an entry: amount was settled, the rest released.

Fields

by: EntryId

The resolving entry.

amount: Amount<P>

The amount settled.

Voided

Voided by an entry.

Fields

by: EntryId

The resolving entry.

Expired

Expired by an entry.

Fields

by: EntryId

The resolving entry.

Implementations

impl<const P: u8> HoldStatus<P>

pub const fn resolved_by(&self) -> Option<EntryId>

The entry that resolved the hold; None while open.

Trait Implementations

impl<const P: u8> Clone for HoldStatus<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const P: u8> Copy for HoldStatus<P>

impl<const P: u8> Debug for HoldStatus<P>

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

Formats the value using the given formatter.

impl<'de, const P: u8> Deserialize<'de> for HoldStatus<P>

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const P: u8> Display for HoldStatus<P>

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

open, posted 60.00 by …, voided by … or expired by …, honouring width, fill and alignment.

impl<const P: u8> Eq for HoldStatus<P>

impl<const P: u8> Hash for HoldStatus<P>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const P: u8> PartialEq for HoldStatus<P>

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

Equality operator ==.

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

Inequality operator !=.

impl<const P: u8> Serialize for HoldStatus<P>

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const P: u8> StructuralPartialEq for HoldStatus<P>