Struct TapTree

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

Taproot Tree representing a complete binary tree without any hidden nodes.

This is in contrast to NodeInfo, which allows hidden nodes. The implementations for Eq, PartialEq and Hash compare the merkle root of the tree

Implementations

impl TapTree

pub fn node_info(&self) -> &NodeInfo

Gets the reference to inner NodeInfo of this tree root.

pub fn into_node_info(self) -> NodeInfo

Gets the inner NodeInfo of this tree root.

pub fn script_leaves(&self) -> ScriptLeaves<'_>

Returns [TapTreeIter<'_>] iterator for a taproot script tree, operating in DFS order over tree ScriptLeafs.

pub fn root_hash(&self) -> TapNodeHash

Returns the root TapNodeHash of this tree.

Trait Implementations

impl Clone for TapTree

fn clone(&self) -> TapTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TapTree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TapTree

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TapTree> for NodeInfo

fn from(tree: TapTree) -> NodeInfo

Converts to this type from the input type.

impl Hash for TapTree

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 PartialEq for TapTree

fn eq(&self, other: &TapTree) -> 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 Serialize for TapTree

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<NodeInfo> for TapTree

fn try_from( node_info: NodeInfo, ) -> Result<TapTree, <TapTree as TryFrom<NodeInfo>>::Error>

Constructs TapTree from a NodeInfo if it is complete binary tree.

Returns

A TapTree iff the NodeInfo has no hidden nodes, otherwise return HiddenNodesError error with the content of incomplete NodeInfo instance.

type Error = HiddenNodesError

The type returned in the event of a conversion error.

impl TryFrom<TaprootBuilder> for TapTree

fn try_from( builder: TaprootBuilder, ) -> Result<TapTree, <TapTree as TryFrom<TaprootBuilder>>::Error>

Constructs TapTree from a TaprootBuilder if it is complete binary tree.

Returns

A TapTree iff the builder is complete, otherwise return IncompleteBuilderError error with the content of incomplete builder instance.

type Error = IncompleteBuilderError

The type returned in the event of a conversion error.

impl Eq for TapTree

impl StructuralPartialEq for TapTree