Struct TaprootMerkleBranch

pub struct TaprootMerkleBranch(/* private fields */);

The merkle proof for inclusion of a tree in a taptree hash.

Implementations

impl TaprootMerkleBranch

pub fn as_inner(&self) -> &[Hash]

Returns a reference to the inner vector of hashes.

pub fn from_slice(sl: &[u8]) -> Result<TaprootMerkleBranch, TaprootError>

Creates a merkle proof from raw data representing a list of hashes.

pub fn encode<Write>(&self, writer: Write) -> Result<usize, Error>

where Write: Write,

Serializes to a writer.

Returns

The number of bytes written to the writer.

pub fn serialize(&self) -> Vec<u8>

Serializes self as bytes.

pub fn from_inner(inner: Vec<Hash>) -> Result<TaprootMerkleBranch, TaprootError>

👎Deprecated since 0.29.0: use try_from instead

Creates a merkle proof from list of hashes.

Errors

If inner proof length is more than TAPROOT_CONTROL_MAX_NODE_COUNT (128).

pub fn into_inner(self) -> Vec<Hash>

Returns the inner list of hashes.

Trait Implementations

impl Clone for TaprootMerkleBranch

fn clone(&self) -> TaprootMerkleBranch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaprootMerkleBranch

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

Formats the value using the given formatter.

impl Default for TaprootMerkleBranch

fn default() -> TaprootMerkleBranch

Returns the “default value” for a type.

impl Hash for TaprootMerkleBranch

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TaprootMerkleBranch

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TaprootMerkleBranch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TaprootMerkleBranch

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&[Hash]> for TaprootMerkleBranch

fn try_from( v: &[Hash], ) -> Result<TaprootMerkleBranch, <TaprootMerkleBranch as TryFrom<&[Hash]>>::Error>

Creates a merkle proof from list of hashes.

Errors

If inner proof length is more than TAPROOT_CONTROL_MAX_NODE_COUNT (128).

type Error = TaprootError

The type returned in the event of a conversion error.

impl TryFrom<Box<[Hash]>> for TaprootMerkleBranch

fn try_from( v: Box<[Hash]>, ) -> Result<TaprootMerkleBranch, <TaprootMerkleBranch as TryFrom<Box<[Hash]>>>::Error>

Creates a merkle proof from list of hashes.

Errors

If inner proof length is more than TAPROOT_CONTROL_MAX_NODE_COUNT (128).

type Error = TaprootError

The type returned in the event of a conversion error.

impl TryFrom<Vec<Hash>> for TaprootMerkleBranch

fn try_from( v: Vec<Hash>, ) -> Result<TaprootMerkleBranch, <TaprootMerkleBranch as TryFrom<Vec<Hash>>>::Error>

Creates a merkle proof from list of hashes.

Errors

If inner proof length is more than TAPROOT_CONTROL_MAX_NODE_COUNT (128).

type Error = TaprootError

The type returned in the event of a conversion error.

impl Eq for TaprootMerkleBranch

impl StructuralPartialEq for TaprootMerkleBranch