Enum TapTree

#[non_exhaustive]
pub enum TapTree<Pk: MiniscriptKey, Ext: Extension = NoExt> {
    Tree(Arc<TapTree<Pk, Ext>>, Arc<TapTree<Pk, Ext>>),
    Leaf(Arc<Miniscript<Pk, Tap, Ext>>),
}

A Taproot Tree representation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Tree(Arc<TapTree<Pk, Ext>>, Arc<TapTree<Pk, Ext>>)

A taproot tree structure

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

A taproot leaf denoting a spending condition

Implementations

impl<Pk: MiniscriptKey, Ext: Extension> TapTree<Pk, Ext>

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

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

Trait Implementations

impl<Pk: Clone + MiniscriptKey, Ext: Clone + Extension> Clone for TapTree<Pk, Ext>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Pk: MiniscriptKey, Ext: Extension> Debug for TapTree<Pk, Ext>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey, Ext: Extension> Display for TapTree<Pk, Ext>

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

Formats the value using the given formatter.

impl<Pk: Hash + MiniscriptKey, Ext: Hash + Extension> Hash for TapTree<Pk, Ext>

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, Ext: Extension> Liftable<Pk> for TapTree<Pk, Ext>

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

Convert the object into an abstract policy

impl<Pk: Ord + MiniscriptKey, Ext: Ord + Extension> Ord for TapTree<Pk, Ext>

fn cmp(&self, other: &TapTree<Pk, Ext>) -> 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<Pk: PartialEq + MiniscriptKey, Ext: PartialEq + Extension> PartialEq for TapTree<Pk, Ext>

fn eq(&self, other: &TapTree<Pk, Ext>) -> 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<Pk: PartialOrd + MiniscriptKey, Ext: PartialOrd + Extension> PartialOrd for TapTree<Pk, Ext>

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

impl<Pk: MiniscriptKey, Ext: Extension> StructuralPartialEq for TapTree<Pk, Ext>