Enum MovementStatus

pub enum MovementStatus {
    Pending,
    Finished,
    Failed,
    Cancelled,
}

Represents the current status of a Movement.

Variants

Pending

The default status of a new Movement. Should be treated as in-progress.

Finished

The Movement has completed with changes. Note; this does not necessarily mean the Movement completed successfully, e.g., VTXOs may be consumed and new ones produced.

Failed

The Movement failed to complete due to an error. This should result in changes in user funds.

Cancelled

A Movement was cancelled, either by the protocol (e.g., lightning payments) or by the user.

Implementations

impl MovementStatus

pub fn as_str(&self) -> &'static str

Returns the canonical stable string for this status.

The returned value is intended for persistence and interoperability. Use MovementStatus::from_str to parse it back.

Trait Implementations

impl Clone for MovementStatus

fn clone(&self) -> MovementStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MovementStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MovementStatus

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MovementStatus

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

Formats the value using the given formatter.

impl From<OnDropStatus> for MovementStatus

fn from(status: OnDropStatus) -> Self

Converts to this type from the input type.

impl FromStr for MovementStatus

fn from_str(s: &str) -> Result<Self, Self::Err>

Formats the kind as its canonical string (same as MovementStatus::as_str).

type Err = Error

The associated error which can be returned from parsing.

impl Hash for MovementStatus

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 Ord for MovementStatus

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MovementStatus

fn eq(&self, other: &MovementStatus) -> 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 PartialOrd for MovementStatus

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for MovementStatus

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MovementStatus

impl Eq for MovementStatus

impl StructuralPartialEq for MovementStatus