Enum lightning::ln::msgs::OptionalField

pub enum OptionalField<T> {
    Present(T),
    Absent,
}

Messages could have optional fields to use with extended features As we wish to serialize these differently from Option<T>s (Options get a tag byte, but OptionalField simply gets Present if there are enough bytes to read into it), we have a separate enum type for them.

This is not exported to bindings users due to a free generic in T

Variants

Present(T)

Optional field is included in message

Absent

Optional field is absent in message

Trait Implementations

impl<T: Clone> Clone for OptionalField<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OptionalField<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<OptionalField<T>> for OptionalField<T>

fn eq(&self, other: &OptionalField<T>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Readable for OptionalField<Script>

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

Reads a Self in from the given Read.

impl Readable for OptionalField<u64>

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

Reads a Self in from the given Read.

impl Writeable for OptionalField<Script>

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<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 OptionalField<u64>

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<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> Eq for OptionalField<T>

impl<T> StructuralEq for OptionalField<T>

impl<T> StructuralPartialEq for OptionalField<T>