Struct Features

pub struct Features<T>
where
    T: Context,
{ /* private fields */ }

Tracks the set of features which a node implements, templated by the context in which it appears.

This is not exported to bindings users as we map the concrete feature types below directly instead

Implementations

impl<T> Features<T>

where T: DataLossProtect,

pub fn set_data_loss_protect_optional(&mut self)

Set this feature as optional.

pub fn set_data_loss_protect_required(&mut self)

Set this feature as required.

pub fn supports_data_loss_protect(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: DataLossProtect,

pub fn requires_data_loss_protect(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: InitialRoutingSync,

pub fn set_initial_routing_sync_optional(&mut self)

Set this feature as optional.

pub fn set_initial_routing_sync_required(&mut self)

Set this feature as required.

pub fn initial_routing_sync(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: UpfrontShutdownScript,

pub fn set_upfront_shutdown_script_optional(&mut self)

Set this feature as optional.

pub fn set_upfront_shutdown_script_required(&mut self)

Set this feature as required.

pub fn supports_upfront_shutdown_script(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: UpfrontShutdownScript,

pub fn requires_upfront_shutdown_script(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: GossipQueries,

pub fn set_gossip_queries_optional(&mut self)

Set this feature as optional.

pub fn set_gossip_queries_required(&mut self)

Set this feature as required.

pub fn supports_gossip_queries(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: GossipQueries,

pub fn requires_gossip_queries(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: VariableLengthOnion,

pub fn set_variable_length_onion_optional(&mut self)

Set this feature as optional.

pub fn set_variable_length_onion_required(&mut self)

Set this feature as required.

pub fn supports_variable_length_onion(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: VariableLengthOnion,

pub fn requires_variable_length_onion(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: StaticRemoteKey,

pub fn set_static_remote_key_optional(&mut self)

Set this feature as optional.

pub fn set_static_remote_key_required(&mut self)

Set this feature as required.

pub fn supports_static_remote_key(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: StaticRemoteKey,

pub fn requires_static_remote_key(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: PaymentSecret,

pub fn set_payment_secret_optional(&mut self)

Set this feature as optional.

pub fn set_payment_secret_required(&mut self)

Set this feature as required.

pub fn supports_payment_secret(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: PaymentSecret,

pub fn requires_payment_secret(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: BasicMPP,

pub fn set_basic_mpp_optional(&mut self)

Set this feature as optional.

pub fn set_basic_mpp_required(&mut self)

Set this feature as required.

pub fn supports_basic_mpp(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: BasicMPP,

pub fn requires_basic_mpp(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: Wumbo,

pub fn set_wumbo_optional(&mut self)

Set this feature as optional.

pub fn set_wumbo_required(&mut self)

Set this feature as required.

pub fn supports_wumbo(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: Wumbo,

pub fn requires_wumbo(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: AnchorsNonzeroFeeHtlcTx,

pub fn set_anchors_nonzero_fee_htlc_tx_optional(&mut self)

Set this feature as optional.

pub fn set_anchors_nonzero_fee_htlc_tx_required(&mut self)

Set this feature as required.

pub fn supports_anchors_nonzero_fee_htlc_tx(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: AnchorsNonzeroFeeHtlcTx,

pub fn requires_anchors_nonzero_fee_htlc_tx(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: AnchorsZeroFeeHtlcTx,

pub fn set_anchors_zero_fee_htlc_tx_optional(&mut self)

Set this feature as optional.

pub fn set_anchors_zero_fee_htlc_tx_required(&mut self)

Set this feature as required.

pub fn supports_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: AnchorsZeroFeeHtlcTx,

pub fn requires_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: ShutdownAnySegwit,

pub fn set_shutdown_any_segwit_optional(&mut self)

Set this feature as optional.

pub fn set_shutdown_any_segwit_required(&mut self)

Set this feature as required.

pub fn supports_shutdown_anysegwit(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: ShutdownAnySegwit,

pub fn requires_shutdown_anysegwit(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: Taproot,

pub fn set_taproot_optional(&mut self)

Set this feature as optional.

pub fn set_taproot_required(&mut self)

Set this feature as required.

pub fn supports_taproot(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: Taproot,

pub fn requires_taproot(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: OnionMessages,

pub fn set_onion_messages_optional(&mut self)

Set this feature as optional.

pub fn set_onion_messages_required(&mut self)

Set this feature as required.

pub fn supports_onion_messages(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: OnionMessages,

pub fn requires_onion_messages(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: ChannelType,

pub fn set_channel_type_optional(&mut self)

Set this feature as optional.

pub fn set_channel_type_required(&mut self)

Set this feature as required.

pub fn supports_channel_type(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: ChannelType,

pub fn requires_channel_type(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: SCIDPrivacy,

pub fn set_scid_privacy_optional(&mut self)

Set this feature as optional.

pub fn set_scid_privacy_required(&mut self)

Set this feature as required.

pub fn supports_scid_privacy(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: SCIDPrivacy,

pub fn requires_scid_privacy(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: PaymentMetadata,

pub fn set_payment_metadata_optional(&mut self)

Set this feature as optional.

pub fn set_payment_metadata_required(&mut self)

Set this feature as required.

pub fn supports_payment_metadata(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: PaymentMetadata,

pub fn requires_payment_metadata(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: ZeroConf,

pub fn set_zero_conf_optional(&mut self)

Set this feature as optional.

pub fn set_zero_conf_required(&mut self)

Set this feature as required.

pub fn supports_zero_conf(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: ZeroConf,

pub fn requires_zero_conf(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: Keysend,

pub fn set_keysend_optional(&mut self)

Set this feature as optional.

pub fn set_keysend_required(&mut self)

Set this feature as required.

pub fn supports_keysend(&self) -> bool

Checks if this feature is supported.

impl<T> Features<T>

where T: Keysend,

pub fn requires_keysend(&self) -> bool

Checks if this feature is required.

impl<T> Features<T>

where T: Context,

pub fn empty() -> Features<T>

Create a blank Features with no features set

pub fn from_le_bytes(flags: Vec<u8>) -> Features<T>

Create a Features given a set of flags, in little-endian. This is in reverse byte order from most on-the-wire encodings.

This is not exported to bindings users as we don’t support export across multiple T

pub fn from_be_bytes(flags: Vec<u8>) -> Features<T>

Create a Features given a set of flags, in big-endian. This is in byte order from most on-the-wire encodings.

This is not exported to bindings users as we don’t support export across multiple T

pub fn requires_unknown_bits_from(&self, other: &Features<T>) -> bool

Returns true if this Features object contains required features unknown by other.

pub fn requires_unknown_bits(&self) -> bool

Returns true if this Features object contains unknown feature flags which are set as “required”.

pub fn set_required_feature_bit(&mut self, bit: usize) -> Result<(), ()>

Sets a required feature bit. Errors if bit is outside the feature range as defined by BOLT 9.

Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., bit - 1).

pub fn set_optional_feature_bit(&mut self, bit: usize) -> Result<(), ()>

Sets an optional feature bit. Errors if bit is outside the feature range as defined by BOLT 9.

Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., bit + 1).

pub fn set_required_custom_bit(&mut self, bit: usize) -> Result<(), ()>

Sets a required custom feature bit. Errors if bit is outside the custom range as defined by bLIP 2 or if it is a known T feature.

Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., bit - 1).

pub fn set_optional_custom_bit(&mut self, bit: usize) -> Result<(), ()>

Sets an optional custom feature bit. Errors if bit is outside the custom range as defined by bLIP 2 or if it is a known T feature.

Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., bit + 1).

Trait Implementations

impl Base32Len for Features<Bolt11InvoiceContext>

fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl<T> BitOr for Features<T>

where T: Context,

type Output = Features<T>

The resulting type after applying the | operator.

fn bitor(self, o: Features<T>) -> Features<T>

Performs the | operation.

impl<T, Rhs> BitOrAssign<Rhs> for Features<T>

where T: Context, Rhs: Borrow<Features<T>>,

fn bitor_assign(&mut self, rhs: Rhs)

Performs the |= operation.

impl<T> Clone for Features<T>

where T: Context,

fn clone(&self) -> Features<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Features<T>

where T: Context,

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

Formats the value using the given formatter.

impl Display for Features<BlindedHopContext>

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

Formats the value using the given formatter.

impl Display for Features<Bolt11InvoiceContext>

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

Formats the value using the given formatter.

impl Display for Features<Bolt12InvoiceContext>

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

Formats the value using the given formatter.

impl Display for Features<ChannelContext>

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

Formats the value using the given formatter.

impl Display for Features<ChannelTypeContext>

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

Formats the value using the given formatter.

impl Display for Features<InitContext>

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

Formats the value using the given formatter.

impl Display for Features<InvoiceRequestContext>

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

Formats the value using the given formatter.

impl Display for Features<NodeContext>

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

Formats the value using the given formatter.

impl Display for Features<OfferContext>

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

Formats the value using the given formatter.

impl FromBase32 for Features<Bolt11InvoiceContext>

type Err = Error

The associated error which can be returned from parsing (e.g. because of bad padding).

fn from_base32( field_data: &[u5], ) -> Result<Features<Bolt11InvoiceContext>, Error>

Convert a base32 slice to Self.

impl<T> Hash for Features<T>

where T: Context,

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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<T> Ord for Features<T>

where T: Context + Eq,

fn cmp(&self, other: &Features<T>) -> 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<T> PartialEq for Features<T>

where T: Context,

fn eq(&self, o: &Features<T>) -> 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<T> PartialOrd for Features<T>

where T: Context,

fn partial_cmp(&self, other: &Features<T>) -> 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 Readable for Features<BlindedHopContext>

fn read<R>(r: &mut R) -> Result<Features<BlindedHopContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<Bolt11InvoiceContext>

fn read<R>(r: &mut R) -> Result<Features<Bolt11InvoiceContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<Bolt12InvoiceContext>

fn read<R>(r: &mut R) -> Result<Features<Bolt12InvoiceContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<ChannelContext>

fn read<R>(r: &mut R) -> Result<Features<ChannelContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<ChannelTypeContext>

fn read<R>(r: &mut R) -> Result<Features<ChannelTypeContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<InitContext>

fn read<R>(r: &mut R) -> Result<Features<InitContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Readable for Features<NodeContext>

fn read<R>(r: &mut R) -> Result<Features<NodeContext>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl ToBase32 for Features<Bolt11InvoiceContext>

fn write_base32<W>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err>

where W: WriteBase32,

Encode as base32 and write it to the supplied writer Implementations shouldn’t allocate.

fn to_base32(&self) -> Vec<u5>

Convert Self to base32 vector

impl Writeable for Features<BlindedHopContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<Bolt11InvoiceContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<Bolt12InvoiceContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<ChannelContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<ChannelTypeContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<InitContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Writeable for Features<NodeContext>

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl<T> Eq for Features<T>

where T: Eq + Context,