Trait lnpbp::strict_encoding::StrictEncode

pub trait StrictEncode {
    type Error: Error + From<Error>;
    fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Self::Error>;
}

Binary encoding according to the strict rules that usually apply to consensus-critical data structures. May be used for network communications; in some circumstances may be used for commitment procedures; however it must be kept in mind that sometime commitment may follow "fold" scheme (Merklization or nested commitments) and in such cases this trait can't be applied. It is generally recommended for consensus-related commitments to utilize [CommitVerify], [TryCommitVerify] and [EmbedCommitVerify] traits
from [paradigms::commit_verify] module.

Associated Types

type Error: Error + From<Error>

Implementation-dependent error type

Loading content...

Required methods

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

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

Loading content...

Implementations on Foreign Types

impl<T> StrictEncode for Holder<T, Wrapped> where
    T: Wrapper,
    T::Inner: StrictEncode, 

type Error = <T::Inner as StrictEncode>::Error

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

impl<T> StrictEncode for Holder<T, HashFixedBytes> where
    T: Hash, 

type Error = Error

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

impl<T> StrictEncode for Holder<T, BitcoinConsensus> where
    T: Encodable, 

type Error = Error

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

impl StrictEncode for bool

type Error = Error

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

impl StrictEncode for usize

type Error = Error

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

impl StrictEncode for f32

type Error = Error

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

impl StrictEncode for f64

type Error = Error

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

impl<'_> StrictEncode for &'_ [u8]

type Error = Error

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

impl StrictEncode for Box<[u8]>

type Error = Error

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

impl<'_> StrictEncode for &'_ str

type Error = Error

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

impl StrictEncode for String

type Error = Error

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

impl<T> StrictEncode for Option<T> where
    T: StrictEncode,
    T::Error: From<Error>, 

In terms of strict encoding, Option (optional values) are
represented by a significator byte, which MUST be either 0 (for no value present) or 1, followed by the value strict encoding.

type Error = T::Error

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

impl<T> StrictEncode for Vec<T> where
    T: StrictEncode,
    T::Error: From<Error>, 

In terms of strict encoding, Vec is stored in form of usize-encoded length (see StrictEncode implementation for usize type for encoding platform-independent constant-length encoding rules) followed by a consequently-encoded vec items, according to their type.

type Error = T::Error

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

impl<T> StrictEncode for HashSet<T> where
    T: StrictEncode + Eq + Ord + Hash + Debug,
    T::Error: From<Error>, 

Strict encoding for a unique value collection represented by a rust HashSet type is performed in the same way as Vec encoding. NB: Array members must are ordered with the sort operation, so type T must implement Ord trait in such a way that it produces deterministically-sorted result

type Error = T::Error

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

impl<T> StrictEncode for BTreeSet<T> where
    T: StrictEncode + Eq + Ord + Debug,
    T::Error: From<Error>, 

Strict encoding for a unique value collection represented by a rust BTreeSet type is performed in the same way as Vec encoding. NB: Array members must are ordered with the sort operation, so type T must implement Ord trait in such a way that it produces deterministically-sorted result

type Error = T::Error

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

impl<T> StrictEncode for HashMap<usize, T> where
    T: StrictEncode + Clone,
    T::Error: From<Error>, 

LNP/BP library uses HashMap<usize, T: StrictEncode>s to encode ordered lists, where the position of the list item must be fixed, since the item is referenced from elsewhere by its index. Thus, the library does not supports and recommends not to support strict encoding of any other HashMap variants.

Strict encoding of the HashMap<usize, T> type is performed by converting into a fixed-order Vec<T> and serializing it according to the Vec strict encoding rules. This operation is internally performed via conversion into BTreeMap<usize, T: StrictEncode>.

type Error = T::Error

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

impl<K, V> StrictEncode for BTreeMap<K, V> where
    K: StrictEncode + Ord + Clone,
    V: StrictEncode + Clone,
    K::Error: From<Error>,
    V::Error: From<Error> + From<K::Error>, 

LNP/BP library uses BTreeMap<usize, T: StrictEncode>s to encode ordered lists, where the position of the list item must be fixed, since the item is referenced from elsewhere by its index. Thus, the library does not supports and recommends not to support strict encoding of any other BTreeMap variants.

Strict encoding of the BTreeMap<usize, T> type is performed by converting into a fixed-order Vec<T> and serializing it according to the Vec strict encoding rules.

type Error = V::Error

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

impl<K, V> StrictEncode for (K, V) where
    K: StrictEncode + Clone,
    V: StrictEncode + Clone,
    K::Error: From<Error>,
    V::Error: From<Error> + From<K::Error>, 

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

type Error = V::Error

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

impl StrictEncode for Script

type Error = Error

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

impl StrictEncode for SecretKey

type Error = Error

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

impl StrictEncode for PublicKey

type Error = Error

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

impl StrictEncode for Signature

type Error = Error

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

impl StrictEncode for PublicKey

type Error = Error

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

impl StrictEncode for Network

type Error = Error

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

impl StrictEncode for ChildNumber

type Error = Error

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

impl StrictEncode for DerivationPath

type Error = Error

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

impl StrictEncode for ChainCode

type Error = Error

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

impl StrictEncode for Fingerprint

type Error = Error

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

impl StrictEncode for ExtendedPubKey

type Error = Error

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

impl StrictEncode for ExtendedPrivKey

type Error = Error

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

Loading content...

Implementors

impl StrictEncode for AssetLayer

type Error = Error

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

impl StrictEncode for AssetSystem

type Error = Error

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

impl StrictEncode for Chain

type Error = Error

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

impl StrictEncode for ChainFormat

type Error = Error

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

impl StrictEncode for P2pNetworkId

type Error = Error

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

impl StrictEncode for ScriptEncodeData

type Error = Error

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

impl StrictEncode for OutpointReveal

type Error = Error

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

impl StrictEncode for AssetParams

type Error = Error

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

impl StrictEncode for ChainParams

type Error = Error

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

impl StrictEncode for Proof

type Error = Error

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

impl StrictEncode for ShortId

type Error = Error

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

impl StrictEncode for FlagVec

type Error = Error

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

impl StrictEncode for MultimsgCommitment

type Error = Error

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

impl StrictEncode for MultimsgCommitmentItem

type Error = Error

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

impl<T> StrictEncode for T where
    T: Strategy + Clone,
    Holder<T, <T as Strategy>::Strategy>: StrictEncode, 

type Error = <Holder<T, T::Strategy> as StrictEncode>::Error

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

Loading content...