Enum lnp::features::Feature

#[non_exhaustive]
#[repr(u16)]pub enum Feature {
    OptionDataLossProtect,
    InitialRoutingSync,
    OptionUpfrontShutdownScript,
    GossipQueries,
    VarOnionOptin,
    GossipQueriesEx,
    OptionStaticRemotekey,
    PaymentSecret,
    BasicMpp,
    OptionSupportLargeChannel,
    OptionAnchorOutputs,
}

Specific named feature flags

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.

OptionDataLossProtect

Requires or supports extra channel_reestablish fields

InitialRoutingSync

Sending node needs a complete routing information dump

OptionUpfrontShutdownScript

Commits to a shutdown scriptpubkey when opening channel

GossipQueries

More sophisticated gossip control

VarOnionOptin

Requires/supports variable-length routing onion payloads

GossipQueriesEx

Gossip queries can include additional information

OptionStaticRemotekey

Static key for remote output

PaymentSecret

Node supports payment_secret field

BasicMpp

Node can receive basic multi-part payments

OptionSupportLargeChannel

Can create large channels

OptionAnchorOutputs

Anchor outputs

Implementations

impl Feature

pub fn bit(self, required: bool) -> Option<u16>

Returns number of bit that is set by the flag

Arguments

required: which type of flag bit should be returned:

• false for even (non-required) bit variant
• true for odd (required) bit variant

Returns

Bit number in feature verctor if the feature is allowed for the provided required condition; None otherwise.

Trait Implementations

impl Clone for Feature

fn clone(&self) -> Feature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Feature

impl Debug for Feature

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

Formats the value using the given formatter.

impl Display for Feature

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

Formats the value using the given formatter.

impl Eq for Feature

impl FromStr for Feature

type Err = UnknownFeatureError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Feature

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Feature

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Feature> for Feature

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Feature> for Feature

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Feature

impl StructuralPartialEq for Feature