Struct lightning::ln::features::Features

source ·
pub struct Features<T: Context> { /* private fields */ }
Expand description

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

(C-not exported) as we map the concrete feature types below directly instead

Implementations§

source§

impl<T: DataLossProtect> Features<T>

source

pub fn set_data_loss_protect_optional(&mut self)

Set this feature as optional.

source

pub fn set_data_loss_protect_required(&mut self)

Set this feature as required.

source

pub fn supports_data_loss_protect(&self) -> bool

Checks if this feature is supported.

source§

impl<T: DataLossProtect> Features<T>

source

pub fn requires_data_loss_protect(&self) -> bool

Checks if this feature is required.

source§

impl<T: InitialRoutingSync> Features<T>

source

pub fn set_initial_routing_sync_optional(&mut self)

Set this feature as optional.

source

pub fn set_initial_routing_sync_required(&mut self)

Set this feature as required.

source

pub fn initial_routing_sync(&self) -> bool

Checks if this feature is supported.

source§

impl<T: UpfrontShutdownScript> Features<T>

source

pub fn set_upfront_shutdown_script_optional(&mut self)

Set this feature as optional.

source

pub fn set_upfront_shutdown_script_required(&mut self)

Set this feature as required.

source

pub fn supports_upfront_shutdown_script(&self) -> bool

Checks if this feature is supported.

source§

impl<T: UpfrontShutdownScript> Features<T>

source

pub fn requires_upfront_shutdown_script(&self) -> bool

Checks if this feature is required.

source§

impl<T: GossipQueries> Features<T>

source

pub fn set_gossip_queries_optional(&mut self)

Set this feature as optional.

source

pub fn set_gossip_queries_required(&mut self)

Set this feature as required.

source

pub fn supports_gossip_queries(&self) -> bool

Checks if this feature is supported.

source§

impl<T: GossipQueries> Features<T>

source

pub fn requires_gossip_queries(&self) -> bool

Checks if this feature is required.

source§

impl<T: VariableLengthOnion> Features<T>

source

pub fn set_variable_length_onion_optional(&mut self)

Set this feature as optional.

source

pub fn set_variable_length_onion_required(&mut self)

Set this feature as required.

source

pub fn supports_variable_length_onion(&self) -> bool

Checks if this feature is supported.

source§

impl<T: VariableLengthOnion> Features<T>

source

pub fn requires_variable_length_onion(&self) -> bool

Checks if this feature is required.

source§

impl<T: StaticRemoteKey> Features<T>

source

pub fn set_static_remote_key_optional(&mut self)

Set this feature as optional.

source

pub fn set_static_remote_key_required(&mut self)

Set this feature as required.

source

pub fn supports_static_remote_key(&self) -> bool

Checks if this feature is supported.

source§

impl<T: StaticRemoteKey> Features<T>

source

pub fn requires_static_remote_key(&self) -> bool

Checks if this feature is required.

source§

impl<T: PaymentSecret> Features<T>

source

pub fn set_payment_secret_optional(&mut self)

Set this feature as optional.

source

pub fn set_payment_secret_required(&mut self)

Set this feature as required.

source

pub fn supports_payment_secret(&self) -> bool

Checks if this feature is supported.

source§

impl<T: PaymentSecret> Features<T>

source

pub fn requires_payment_secret(&self) -> bool

Checks if this feature is required.

source§

impl<T: BasicMPP> Features<T>

source

pub fn set_basic_mpp_optional(&mut self)

Set this feature as optional.

source

pub fn set_basic_mpp_required(&mut self)

Set this feature as required.

source

pub fn supports_basic_mpp(&self) -> bool

Checks if this feature is supported.

source§

impl<T: BasicMPP> Features<T>

source

pub fn requires_basic_mpp(&self) -> bool

Checks if this feature is required.

source§

impl<T: Wumbo> Features<T>

source

pub fn set_wumbo_optional(&mut self)

Set this feature as optional.

source

pub fn set_wumbo_required(&mut self)

Set this feature as required.

source

pub fn supports_wumbo(&self) -> bool

Checks if this feature is supported.

source§

impl<T: Wumbo> Features<T>

source

pub fn requires_wumbo(&self) -> bool

Checks if this feature is required.

source§

impl<T: AnchorsZeroFeeHtlcTx> Features<T>

source

pub fn set_anchors_zero_fee_htlc_tx_optional(&mut self)

Set this feature as optional.

source

pub fn set_anchors_zero_fee_htlc_tx_required(&mut self)

Set this feature as required.

source

pub fn supports_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is supported.

source§

impl<T: AnchorsZeroFeeHtlcTx> Features<T>

source

pub fn requires_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is required.

source§

impl<T: ShutdownAnySegwit> Features<T>

source

pub fn set_shutdown_any_segwit_optional(&mut self)

Set this feature as optional.

source

pub fn set_shutdown_any_segwit_required(&mut self)

Set this feature as required.

source

pub fn supports_shutdown_anysegwit(&self) -> bool

Checks if this feature is supported.

source§

impl<T: ShutdownAnySegwit> Features<T>

source

pub fn requires_shutdown_anysegwit(&self) -> bool

Checks if this feature is required.

source§

impl<T: OnionMessages> Features<T>

source

pub fn set_onion_messages_optional(&mut self)

Set this feature as optional.

source

pub fn set_onion_messages_required(&mut self)

Set this feature as required.

source

pub fn supports_onion_messages(&self) -> bool

Checks if this feature is supported.

source§

impl<T: OnionMessages> Features<T>

source

pub fn requires_onion_messages(&self) -> bool

Checks if this feature is required.

source§

impl<T: ChannelType> Features<T>

source

pub fn set_channel_type_optional(&mut self)

Set this feature as optional.

source

pub fn set_channel_type_required(&mut self)

Set this feature as required.

source

pub fn supports_channel_type(&self) -> bool

Checks if this feature is supported.

source§

impl<T: ChannelType> Features<T>

source

pub fn requires_channel_type(&self) -> bool

Checks if this feature is required.

source§

impl<T: SCIDPrivacy> Features<T>

source

pub fn set_scid_privacy_optional(&mut self)

Set this feature as optional.

source

pub fn set_scid_privacy_required(&mut self)

Set this feature as required.

source

pub fn supports_scid_privacy(&self) -> bool

Checks if this feature is supported.

source§

impl<T: SCIDPrivacy> Features<T>

source

pub fn requires_scid_privacy(&self) -> bool

Checks if this feature is required.

source§

impl<T: ZeroConf> Features<T>

source

pub fn set_zero_conf_optional(&mut self)

Set this feature as optional.

source

pub fn set_zero_conf_required(&mut self)

Set this feature as required.

source

pub fn supports_zero_conf(&self) -> bool

Checks if this feature is supported.

source§

impl<T: ZeroConf> Features<T>

source

pub fn requires_zero_conf(&self) -> bool

Checks if this feature is required.

source§

impl<T: Keysend> Features<T>

source

pub fn set_keysend_optional(&mut self)

Set this feature as optional.

source

pub fn set_keysend_required(&mut self)

Set this feature as required.

source

pub fn supports_keysend(&self) -> bool

Checks if this feature is supported.

source§

impl<T: Keysend> Features<T>

source

pub fn requires_keysend(&self) -> bool

Checks if this feature is required.

source§

impl<T: Context> Features<T>

source

pub fn empty() -> Self

Create a blank Features with no features set

source

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. (C-not exported) as we don’t support export across multiple T

source

pub fn requires_unknown_bits(&self) -> bool

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

Trait Implementations§

source§

impl<T: Context> Clone for Features<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Context> Debug for Features<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<BlindedHopContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<Bolt12InvoiceContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<ChannelContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<ChannelTypeContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<InitContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<InvoiceContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<InvoiceRequestContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<NodeContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Features<OfferContext>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Context> Hash for Features<T>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T: Context> PartialEq<Features<T>> for Features<T>

source§

fn eq(&self, o: &Self) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: Eq + Context> Eq for Features<T>

source§

impl<T: Context> StructuralEq for Features<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Features<T>where T: RefUnwindSafe,

§

impl<T> Send for Features<T>where T: Send,

§

impl<T> Sync for Features<T>where T: Sync,

§

impl<T> Unpin for Features<T>where T: Unpin,

§

impl<T> UnwindSafe for Features<T>where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> MaybeReadable for Twhere T: Readable,

source§

fn read<R>(reader: &mut R) -> Result<Option<T>, DecodeError>where R: Read,

Reads a Self in from the given Read.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.