Trait LightningEncode

pub trait LightningEncode {
    // Required method
    fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>;

    // Provided method
    fn lightning_serialize(&self) -> Result<Vec<u8>, Error> { ... }
}

Lightning-network specific encoding as defined in BOLT-1, 2, 3…

Required Methods

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

Provided Methods

fn lightning_serialize(&self) -> Result<Vec<u8>, Error>

Serializes data as a byte array using LightningEncode::lightning_encode function.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl LightningEncode for &str

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for &[u8]

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for u8

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for u16

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for u32

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for u64

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for usize

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for Box<[u8]>

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for String

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for FlagVec

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for Slice32

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for u24

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl LightningEncode for Script

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<K, V> LightningEncode for (K, V)

where K: LightningEncode + Clone, V: LightningEncode + Clone,

Two-component tuples are encoded as they were fields in the parent data structure

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<K, V> LightningEncode for BTreeMap<K, V>

where K: LightningEncode, V: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<K, V> LightningEncode for HashMap<K, V>

where K: LightningEncode, V: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Option<T>

where T: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for BTreeSet<T>

where T: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Vec<T>

where T: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for HashSet<T>

where T: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Holder<T, AsBigSize>

where T: Into<BigSize> + Copy,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Holder<T, AsBitcoinHash>

where T: Hash + StrictEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Holder<T, AsStrict>

where T: StrictEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<T> LightningEncode for Holder<T, AsWrapped>

where T: Wrapper, T::Inner: LightningEncode,

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

impl<const LEN: usize> LightningEncode for [u8; LEN]

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Implementors

impl LightningEncode for BigSize

impl<T> LightningEncode for T

where T: Strategy + Clone, Holder<T, <T as Strategy>::Strategy>: LightningEncode,