Struct bitcoin_scripts::taproot::BranchNode

pub struct BranchNode { /* private fields */ }

Ordered set of two branches under taptree node.

Implementations

impl BranchNode

pub fn split(self) -> (TreeNode, TreeNode)

Splits the structure into the left and right nodes, ordered according to bitcoin consensus rules (by the lexicographic order of the node hash values).

pub fn split_dfs(self) -> (TreeNode, TreeNode)

Splits the structure into the left and right nodes, ordered according to the original DFS order.

pub fn as_left_node(&self) -> &TreeNode

Returns reference for to left (in bitcoin consensus lexicographic ordering) child node.

pub fn as_right_node(&self) -> &TreeNode

Returns reference for to right (in bitcoin consensus lexicographic ordering) child node.

pub fn as_dfs_child_node(&self, direction: DfsOrder) -> &TreeNode

Returns reference to the child node at specific DFS direction.

pub fn as_dfs_first_node(&self) -> &TreeNode

Returns reference to the first (in DFS ordering) child node.

pub fn as_dfs_last_node(&self) -> &TreeNode

Returns reference to the last (in DFS ordering) child node.

Trait Implementations

impl Branch for BranchNode

fn subtree_depth(&self) -> Option<u8>

Returns the depth of the subtree under this branch node, if the subtree is fully known (i.e. does not contain hidden nodes), or None otherwise. The depth of subtree for leaf nodes is zero.

fn dfs_ordering(&self) -> DfsOrdering

Returns correspondence between internal child node ordering and their DFS ordering.

fn branch_hash(&self) -> TapBranchHash

Computes branch hash of this branch node.

impl Clone for BranchNode

fn clone(&self) -> BranchNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BranchNode

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

Formats the value using the given formatter.

impl Hash for BranchNode

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 BranchNode

fn cmp(&self, other: &BranchNode) -> 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<BranchNode> for BranchNode

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

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

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

This method tests for !=.

impl PartialOrd<BranchNode> for BranchNode

fn partial_cmp(&self, other: &BranchNode) -> 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 StrictDecode for BranchNode

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 BranchNode

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 Eq for BranchNode

impl StructuralEq for BranchNode

impl StructuralPartialEq for BranchNode