Struct bitcoin_scripts::taproot::TaprootScriptTree

pub struct TaprootScriptTree { /* private fields */ }

Taproot script tree which keeps internal information in a tree data structure, which can be modified by adding or removing parts of the tree (subtrees). See Self::join, Self::split, Self::instill, Self::cut operations.

The structure can be build out of (or converted into) TapTree taproot tree representation, which doesn’t have a modifiable tree structure.

Implementations

impl TaprootScriptTree

pub fn with(root: TreeNode) -> Result<TaprootScriptTree, TaprootTreeError>

Constructs new script tree from the root node.

Errors.

If any of the branches under the root node has non-consensus ordering of the child nodes (i.e. by lexicographic order of the node hash values).

pub fn scripts(&self) -> TreeScriptIter<'_>

Returns iterator over known scripts stored in the tree.

NB: the iterator ignores scripts behind hidden nodes.

pub fn nodes(&self) -> TreeNodeIter<'_>

Returns iterator over all known nodes of the tree.

pub fn nodes_on_path<'node, 'path>(
    &'node self,
    path: &'path [DfsOrder]
) -> TreePathIter<'node, 'path>

Returns iterator over all subnodes on a given path.

pub fn node_at(
    &self,
    path: impl AsRef<[DfsOrder]>
) -> Result<&TreeNode, DfsTraversalError>

Traverses tree using the provided path in DFS order and returns the node reference at the tip of the path.

Errors

Returns DfsTraversalError if the path can’t be traversed.

pub fn join(
    self,
    other_tree: TaprootScriptTree,
    other_dfs_order: DfsOrder
) -> Result<TaprootScriptTree, MaxDepthExceeded>

Joins two trees together under a new root.

Creates a new tree with the root node containing self and other_tree as its direct children. The other_tree is put into other_dfs_order side.

pub fn split(
    self
) -> Result<(TaprootScriptTree, TaprootScriptTree), UnsplittableTree>

Splits the tree into two subtrees. Errors if the tree root is hidden or a script leaf.

Returns

Two child nodes under the root of the original tree as a new taproot script trees in the original DFS ordering.

pub fn instill(
    &mut self,
    other_tree: TaprootScriptTree,
    path: impl AsRef<[DfsOrder]>,
    dfs_order: DfsOrder
) -> Result<DfsPath, InstillError>

Instills other_tree as a subtree under provided path by creating a new branch node at the path and putting other_tree on the dfs_side of it.

Error

Returns InstillError when the given path can’t be traversed or the resulting tree depth exceeds taproot tree depth limit.

pub fn cut(
    self,
    path: impl AsRef<[DfsOrder]>,
    dfs_side: DfsOrder
) -> Result<(TaprootScriptTree, TaprootScriptTree), CutError>

Cuts subtree out of this tree at the path, returning this tree without the cut branch and the cut subtree as a new tree.

Returns

Modified original tree without the cut node and a new tree constructed out of the cut node.

Error

Returns DfsTraversalError when the given path can’t be traversed or points at an unsplittable node (leaf node or a hidden node).

pub fn as_root_node(&self) -> &TreeNode

Returns reference to the root node of the tree.

pub fn into_root_node(self) -> TreeNode

Consumes the tree and returns instance of the root node of the tree.

pub fn to_root_node(&self) -> TreeNode

Returns a cloned root node.

Trait Implementations

impl AsRef<TreeNode> for TaprootScriptTree

fn as_ref(&self) -> &TreeNode

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<TreeNode> for TaprootScriptTree

fn borrow(&self) -> &TreeNode

Immutably borrows from an owned value.

impl BorrowMut<TreeNode> for TaprootScriptTree

fn borrow_mut(&mut self) -> &mut TreeNode

Mutably borrows from an owned value.

impl Clone for TaprootScriptTree

fn clone(&self) -> TaprootScriptTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaprootScriptTree

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

Formats the value using the given formatter.

impl Display for TaprootScriptTree

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

Formats the value using the given formatter.

impl From<&TaprootScriptTree> for TapTree

fn from(tree: &TaprootScriptTree) -> Self

Converts to this type from the input type.

impl From<TapTree> for TaprootScriptTree

fn from(tree: TapTree) -> Self

Converts to this type from the input type.

impl From<TaprootScriptTree> for TapTree

fn from(tree: TaprootScriptTree) -> Self

Converts to this type from the input type.

impl Hash for TaprootScriptTree

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<'tree> IntoIterator for &'tree TaprootScriptTree

type Item = (u8, &'tree LeafScript)

The type of the elements being iterated over.

type IntoIter = TreeScriptIter<'tree>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for TaprootScriptTree

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

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

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

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

This method tests for !=.

impl PartialOrd<TaprootScriptTree> for TaprootScriptTree

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

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

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for TaprootScriptTree

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

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for TaprootScriptTree

impl StructuralEq for TaprootScriptTree

impl StructuralPartialEq for TaprootScriptTree