Enum VtxoSpendState 

#[repr(i32)]
pub enum VtxoSpendState {
    Unspecified = 0,
    Spendable = 1,
    Spent = 2,
    Unclaimed = 3,
    Unregistered = 4,
    HtlcRecvUnclaimed = 5,
}

Client-relevant spend state for a user-owned VTXO.

Server-internal states (pool, forfeit, connector) are never returned; in-flight Lightning-receive HTLCs are reported as HTLC_RECV_UNCLAIMED because the client must reveal the preimage to claim them before they become spendable.

Variants

Unspecified = 0

Spendable = 1

The VTXO is available for spending.

Spent = 2

The VTXO has been spent (via round, OOR, or offboard).

Unclaimed = 3

The VTXO originates from a round but the server has not released the unlock preimage yet.

Unregistered = 4

The VTXO’s signed transaction chain has not been uploaded yet.

HtlcRecvUnclaimed = 5

The VTXO’s preimage haven’t been revealed yet

Implementations

impl VtxoSpendState

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of VtxoSpendState.

pub fn from_i32(value: i32) -> Option<VtxoSpendState>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a VtxoSpendState, or None if value is not a valid variant.

impl VtxoSpendState

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

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for VtxoSpendState

fn clone(&self) -> VtxoSpendState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VtxoSpendState

impl Debug for VtxoSpendState

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

Formats the value using the given formatter.

impl Default for VtxoSpendState

fn default() -> VtxoSpendState

Returns the “default value” for a type.

impl Eq for VtxoSpendState

impl From<VtxoSpendState> for i32

fn from(value: VtxoSpendState) -> i32

Converts to this type from the input type.

impl Hash for VtxoSpendState

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 VtxoSpendState

fn cmp(&self, other: &VtxoSpendState) -> 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 VtxoSpendState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VtxoSpendState

fn partial_cmp(&self, other: &VtxoSpendState) -> 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 StructuralPartialEq for VtxoSpendState

impl TryFrom<i32> for VtxoSpendState

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<VtxoSpendState, UnknownEnumValue>

Performs the conversion.