Enum miniscript::descriptor::TapTree

pub enum TapTree<Pk: MiniscriptKey> {
    Tree {
        left: Arc<TapTree<Pk>>,
        right: Arc<TapTree<Pk>>,
        height: usize,
    },
    Leaf(Arc<Miniscript<Pk, Tap>>),
}

A Taproot Tree representation.

Variants

Tree

Fields

left: Arc<TapTree<Pk>>

Left tree branch.

right: Arc<TapTree<Pk>>

Right tree branch.

height: usize

Tree height, defined as 1 + max(left_height, right_height).

A taproot tree structure

Leaf(Arc<Miniscript<Pk, Tap>>)

A taproot leaf denoting a spending condition

Implementations

impl<Pk: MiniscriptKey> TapTree<Pk>

pub fn combine(left: TapTree<Pk>, right: TapTree<Pk>) -> Self

Creates a TapTree by combining left and right tree nodes.

pub fn height(&self) -> usize

Returns the height of this tree.

pub fn iter(&self) -> TapTreeIter<'_, Pk>

Iterates over all miniscripts in DFS walk order compatible with the PSBT requirements (BIP 371).

Trait Implementations

impl<Pk: Clone + MiniscriptKey> Clone for TapTree<Pk>

fn clone(&self) -> TapTree<Pk>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Pk: MiniscriptKey> Debug for TapTree<Pk>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> Display for TapTree<Pk>

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

Formats the value using the given formatter.

impl<Pk: Hash + MiniscriptKey> Hash for TapTree<Pk>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Pk: MiniscriptKey> Liftable<Pk> for TapTree<Pk>

fn lift(&self) -> Result<Policy<Pk>, Error>

Converts this object into an abstract policy.

impl<Pk: Ord + MiniscriptKey> Ord for TapTree<Pk>

fn cmp(&self, other: &TapTree<Pk>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<Pk: PartialEq + MiniscriptKey> PartialEq<TapTree<Pk>> for TapTree<Pk>

fn eq(&self, other: &TapTree<Pk>) -> bool

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

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

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

impl<Pk: PartialOrd + MiniscriptKey> PartialOrd<TapTree<Pk>> for TapTree<Pk>

fn partial_cmp(&self, other: &TapTree<Pk>) -> 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<Pk: Eq + MiniscriptKey> Eq for TapTree<Pk>

impl<Pk: MiniscriptKey> StructuralEq for TapTree<Pk>

impl<Pk: MiniscriptKey> StructuralPartialEq for TapTree<Pk>