Struct lightning::ln::features::Features

pub struct Features<T: Context> { /* fields omitted */ }

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

impl<T: DataLossProtect> Features<T>

pub fn set_data_loss_protect_optional(self) -> Self

Set this feature as optional.

pub fn set_data_loss_protect_required(self) -> Self

Set this feature as required.

impl<T: InitialRoutingSync> Features<T>

pub fn set_initial_routing_sync_optional(self) -> Self

Set this feature as optional.

pub fn set_initial_routing_sync_required(self) -> Self

Set this feature as required.

impl<T: UpfrontShutdownScript> Features<T>

pub fn set_upfront_shutdown_script_optional(self) -> Self

Set this feature as optional.

pub fn set_upfront_shutdown_script_required(self) -> Self

Set this feature as required.

impl<T: GossipQueries> Features<T>

pub fn set_gossip_queries_optional(self) -> Self

Set this feature as optional.

pub fn set_gossip_queries_required(self) -> Self

Set this feature as required.

impl<T: VariableLengthOnion> Features<T>

pub fn set_variable_length_onion_optional(self) -> Self

Set this feature as optional.

pub fn set_variable_length_onion_required(self) -> Self

Set this feature as required.

impl<T: StaticRemoteKey> Features<T>

pub fn set_static_remote_key_optional(self) -> Self

Set this feature as optional.

pub fn set_static_remote_key_required(self) -> Self

Set this feature as required.

impl<T: PaymentSecret> Features<T>

pub fn set_payment_secret_optional(self) -> Self

Set this feature as optional.

pub fn set_payment_secret_required(self) -> Self

Set this feature as required.

impl<T: BasicMPP> Features<T>

pub fn set_basic_mpp_optional(self) -> Self

Set this feature as optional.

pub fn set_basic_mpp_required(self) -> Self

Set this feature as required.

impl<T: ShutdownAnySegwit> Features<T>

pub fn set_shutdown_any_segwit_optional(self) -> Self

Set this feature as optional.

pub fn set_shutdown_any_segwit_required(self) -> Self

Set this feature as required.

impl<T: Keysend> Features<T>

pub fn set_keysend_optional(self) -> Self

Set this feature as optional.

pub fn set_keysend_required(self) -> Self

Set this feature as required.

impl<T: Context> Features<T>

pub fn empty() -> Self

Create a blank Features with no features set

pub fn known() -> Self

Creates a Features with the bits set which are known by the implementation

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

impl<T: PaymentSecret> Features<T>

pub fn supports_payment_secret(&self) -> bool

Returns whether the payment_secret feature is supported.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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<NodeContext>

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<InvoiceContext>

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

Formats the value using the given formatter.

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

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

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

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

This method tests for !=.

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

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read

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

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

Writes self out to the given Writer

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

Writes self out to a Vec

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

Writes self out to a Vec

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 + Context> Eq for Features<T>

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