Trait miniscript::iter::TreeLike

pub trait TreeLike: Clone + Sized {
    // Required method
    fn as_node(&self) -> Tree<Self>;

    // Provided methods
    fn n_children(&self) -> usize { ... }
    fn nth_child(&self, n: usize) -> Option<Self> { ... }
    fn pre_order_iter(self) -> PreOrderIter<Self>  { ... }
    fn verbose_pre_order_iter(self) -> VerbosePreOrderIter<Self>  { ... }
    fn post_order_iter(self) -> PostOrderIter<Self>  { ... }
}

A trait for any structure which has the shape of a Miniscript tree.

As a general rule, this should be implemented on references to nodes, rather than nodes themselves, because it provides algorithms that assume copying is cheap.

To implement this trait, you only need to implement the TreeLike::as_node method, which will usually be very mechanical. Everything else is provided. However, to avoid allocations, it may make sense to also implement TreeLike::n_children and TreeLike::nth_child because the default implementations will allocate vectors for n-ary nodes.

Required Methods

fn as_node(&self) -> Tree<Self>

Interpret the node as an abstract node.

Provided Methods

fn n_children(&self) -> usize

Accessor for the number of children this node has.

fn nth_child(&self, n: usize) -> Option<Self>

Accessor for the nth child of the node, if a child with that index exists.

fn pre_order_iter(self) -> PreOrderIter<Self>

Obtains an iterator of all the nodes rooted at the node, in pre-order.

fn verbose_pre_order_iter(self) -> VerbosePreOrderIter<Self>

Obtains a verbose iterator of all the nodes rooted at the DAG, in pre-order.

See the documentation of VerbosePreOrderIter for more information about what this does. Essentially, if you find yourself using Self::pre_order_iter and then adding a stack to manually track which items and their children have been yielded, you may be better off using this iterator instead.

fn post_order_iter(self) -> PostOrderIter<Self>

Obtains an iterator of all the nodes rooted at the DAG, in post order.

Each node is only yielded once, at the leftmost position that it appears in the DAG.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<Pk: MiniscriptKey> TreeLike for Arc<Policy<Pk>>

fn as_node(&self) -> Tree<Self>

impl<Pk: MiniscriptKey> TreeLike for Arc<Policy<Pk>>

fn as_node(&self) -> Tree<Self>

impl<Pk: MiniscriptKey, Ctx: ScriptContext> TreeLike for Arc<Miniscript<Pk, Ctx>>

fn as_node(&self) -> Tree<Self>

Implementors

impl<'a, Pk: MiniscriptKey> TreeLike for &'a miniscript::policy::concrete::Policy<Pk>

impl<'a, Pk: MiniscriptKey> TreeLike for &'a miniscript::policy::semantic::Policy<Pk>

impl<'a, Pk: MiniscriptKey, Ctx: ScriptContext> TreeLike for &'a Miniscript<Pk, Ctx>