Enum BalanceHoldResult

pub enum BalanceHoldResult {
    RootNotFound,
    BlockTimeNotFound,
    Success {
        holds: Option<Vec<BalanceHoldAddr>>,
        total_balance: Box<U512>,
        available_balance: Box<U512>,
        hold: Box<U512>,
        held: Box<U512>,
        effects: Box<Effects>,
    },
    Failure(BalanceHoldError),
}

Result enum that represents all possible outcomes of a balance hold request.

Variants

RootNotFound

Returned if a passed state root hash is not found.

BlockTimeNotFound

Returned if global state does not have an entry for block time.

Success

Balance hold successfully placed.

Fields

holds: Option<Vec<BalanceHoldAddr>>

Hold addresses, if any.

total_balance: Box<U512>

Purse total balance.

available_balance: Box<U512>

Purse available balance after hold placed.

hold: Box<U512>

How much were we supposed to hold?

held: Box<U512>

How much did we actually hold?

effects: Box<Effects>

Effects of bidding interaction.

Failure(BalanceHoldError)

Failed to place balance hold.

Implementations

impl BalanceHoldResult

pub fn success( holds: Option<Vec<BalanceHoldAddr>>, total_balance: U512, available_balance: U512, hold: U512, held: U512, effects: Effects, ) -> Self

Success ctor.

pub fn total_balance(&self) -> Option<&U512>

Returns the total balance for a BalanceHoldResult::Success variant.

pub fn available_balance(&self) -> Option<&U512>

Returns the available balance for a BalanceHoldResult::Success variant.

pub fn held(&self) -> Option<&U512>

Returns the held amount for a BalanceHoldResult::Success variant.

pub fn holds(&self) -> Option<Vec<BalanceHoldAddr>>

Hold address, if any.

pub fn has_holds(&self) -> bool

Does this result contain any hold addresses?

pub fn is_fully_covered(&self) -> bool

Was the hold fully covered?

pub fn is_success(&self) -> bool

Was the hold successful?

pub fn is_root_not_found(&self) -> bool

Was the root not found?

pub fn effects(&self) -> Effects

The effects, if any.

pub fn error_message(&self) -> String

Error message.

Trait Implementations

impl Debug for BalanceHoldResult

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

Formats the value using the given formatter.

impl From<BalanceFailure> for BalanceHoldResult

fn from(be: BalanceFailure) -> Self

Converts to this type from the input type.

impl From<Error> for BalanceHoldResult

fn from(tce: TrackingCopyError) -> Self

Converts to this type from the input type.