Struct lnpbp::dbc::spk::SpkCommitment

pub struct SpkCommitment(_);

PubkeyScript containing LNPBP-2 commitment

Trait Implementations

impl AsMut<<SpkCommitment as Wrapper>::Inner> for SpkCommitment

pub fn as_mut(&mut self) -> &mut Self::Inner

Performs the conversion.

impl AsRef<<SpkCommitment as Wrapper>::Inner> for SpkCommitment

pub fn as_ref(&self) -> &Self::Inner

Performs the conversion.

impl Borrow<<SpkCommitment as Wrapper>::Inner> for SpkCommitment

pub fn borrow(&self) -> &Self::Inner

Immutably borrows from an owned value.

impl BorrowMut<<SpkCommitment as Wrapper>::Inner> for SpkCommitment

pub fn borrow_mut(&mut self) -> &mut Self::Inner

Mutably borrows from an owned value.

impl Clone for SpkCommitment

pub fn clone(&self) -> SpkCommitment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpkCommitment

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

Formats the value using the given formatter.

impl Default for SpkCommitment

pub fn default() -> SpkCommitment

Returns the "default value" for a type.

impl Deref for SpkCommitment

type Target = Self::Inner

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SpkCommitment

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for SpkCommitment

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

Formats the value using the given formatter.

impl<MSG> EmbedCommitVerify<MSG> for SpkCommitment where
    MSG: AsRef<[u8]>, 

type Container = SpkContainer

External container type that will be used to host commitment to a message

type Error = Error

Error type that may be reported during [commit_embed] procedure

pub fn embed_commit(
    container: &mut Self::Container,
    msg: &MSG
) -> Result<Self, Self::Error>

Creates a commitment and embeds it into the provided container returning Self containing both message commitment and all additional data required to reconstruct the original container

pub fn verify(
    &self,
    container: &Self::Container,
    msg: &MSG
) -> Result<bool, Self::Error>

Verifies commitment against the message; default implementation just reconstructs the original container with [container] function, repeats the commitment to the message and check it against the self.

impl Eq for SpkCommitment

impl From<PubkeyScript> for SpkCommitment

pub fn from(v: PubkeyScript) -> Self

Performs the conversion.

impl Hash for SpkCommitment

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for SpkCommitment

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

Formats the value using the given formatter.

impl Ord for SpkCommitment

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SpkCommitment> for SpkCommitment

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

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

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

This method tests for !=.

impl PartialOrd<SpkCommitment> for SpkCommitment

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for SpkCommitment

impl StructuralPartialEq for SpkCommitment

impl UpperHex for SpkCommitment

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

Formats the value using the given formatter.

impl Wrapper for SpkCommitment

type Inner = PubkeyScript

Inner type wrapped by the current newtype

pub fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

pub fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

pub fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

pub fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

pub fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them