Struct commit_verify::multi_commit::MultiCommitBlock

pub struct MultiCommitBlock {
    pub commitments: Vec<MultiCommitItem>,
    pub entropy: Option<u64>,
}

Multi-message commitment data according to LNPBP-4 specification.

To create commitment use TryCommitVerify::try_commit method.

Fields

commitments: Vec<MultiCommitItem>

Array of commitment items (see MultiCommitItem)

entropy: Option<u64>

Entropy used for placeholders. May be unknown if the message is not constructed via TryCommitVerify::try_commit method but is provided by a third-party, whishing to conceal that information.

Trait Implementations

impl Clone for MultiCommitBlock

fn clone(&self) -> MultiCommitBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitEncode for MultiCommitBlock

fn commit_encode<E: Write>(&self, e: E) -> usize

Encodes the data for the commitment by writing them directly into a io::Write writer instance

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

Serializes data for the commitment in-memory into a newly allocated array

impl ConsensusCommit for MultiCommitBlock

type Commitment = MultiCommitment

Type of the resulting commitment

fn consensus_commit(&self) -> Self::Commitment

Performs commitment to client-side-validated data

fn consensus_verify(&self, commitment: &Self::Commitment) -> bool

Verifies commitment to client-side-validated data

impl Debug for MultiCommitBlock

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

Formats the value using the given formatter.

impl Default for MultiCommitBlock

fn default() -> MultiCommitBlock

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MultiCommitBlock

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for MultiCommitBlock

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for MultiCommitBlock

fn cmp(&self, other: &MultiCommitBlock) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MultiCommitBlock> for MultiCommitBlock

fn eq(&self, other: &MultiCommitBlock) -> bool

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

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

This method tests for !=.

impl PartialOrd<MultiCommitBlock> for MultiCommitBlock

fn partial_cmp(&self, other: &MultiCommitBlock) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MultiCommitBlock

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StrictDecode for MultiCommitBlock

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode

impl StrictEncode for MultiCommitBlock

fn strict_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.

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

Serializes data as a byte array using StrictEncode::strict_encode function

impl TryCommitVerify<MultiSource, UntaggedProtocol> for MultiCommitBlock

type Error = Error

Error type that may be reported during TryCommitVerify::try_commit and TryCommitVerify::try_verify procedures

fn try_commit(source: &MultiSource) -> Result<Self, Error>

Tries to create commitment to a byte representation of a given message

fn try_verify(&self, msg: &Msg) -> Result<bool, Self::Error>

Tries to verify commitment against the message; default implementation just repeats the commitment to the message and check it against the self.

impl Eq for MultiCommitBlock

impl StructuralEq for MultiCommitBlock

impl StructuralPartialEq for MultiCommitBlock