Enum Inner

pub enum Inner<C, J, X, W> {
    Iden,
    Unit,
    InjL(C),
    InjR(C),
    Take(C),
    Drop(C),
    Comp(C, C),
    Case(C, C),
    AssertL(C, Cmr),
    AssertR(Cmr, C),
    Pair(C, C),
    Disconnect(C, X),
    Witness(W),
    Fail(FailEntropy),
    Jet(J),
    Word(Word),
}

Internal “Simplicity DAG” structure.

This structure is used to indicate the type of a node and provide pointers or references to its children, if any.

Variants

Iden

Identity

Unit

Unit constant

InjL(C)

Left injection of some child

InjR(C)

Right injection of some child

Take(C)

Take of some child

Drop(C)

Drop of some child

Comp(C, C)

Composition of a left and right child

Case(C, C)

Case of a left and right child

AssertL(C, Cmr)

Left assertion of a left and right child.

AssertR(Cmr, C)

Right assertion of a left and right child.

Pair(C, C)

Pair of a left and right child

Disconnect(C, X)

Disconnect of a left and right child

Witness(W)

Witness data (missing during commitment, inserted during redemption)

Fail(FailEntropy)

Universal fail

Jet(J)

Application jet

Word(Word)

Constant word

Implementations

impl<C, J: Clone, X, W> Inner<C, J, X, W>

pub fn map<D, F: FnMut(C) -> D>(self, f: F) -> Inner<D, J, X, W>

Convert a node’s combinator data to a different type.

pub fn map_result<D, E, F: FnMut(C) -> Result<D, E>>( self, f: F, ) -> Result<Inner<D, J, X, W>, E>

Convert a node’s combinator data to a different type.

pub fn map_left_right<D, FL, FR>(self, fl: FL, fr: FR) -> Inner<D, J, X, W>

where FL: FnOnce(C) -> D, FR: FnOnce(C) -> D,

Convert a node’s combinator data to a different type, mapping each child separately.

Importantly, the child of an AssertR node is considered the left child, because as a DAG node, this is the sole (left) child, even though as a combinator, it is a right child.

pub fn as_ref(&self) -> Inner<&C, J, &X, &W>

Take references to all contained data.

pub fn disconnect_as_ref(&self) -> Inner<C, J, &X, W>

where J: Copy, C: Copy, W: Copy,

Take references to only the disconnect node.

pub fn map_disconnect<Y, F: FnOnce(X) -> Y>(self, f: F) -> Inner<C, J, Y, W>

pub fn map_disconnect_result<Y, E, F: FnOnce(X) -> Result<Y, E>>( self, f: F, ) -> Result<Inner<C, J, Y, W>, E>

Convert a node’s witness data to a different type.

pub fn map_witness<V, F: FnOnce(W) -> V>(self, f: F) -> Inner<C, J, X, V>

Convert a node’s witness data to a different type.

pub fn map_witness_result<V, E, F: FnOnce(W) -> Result<V, E>>( self, f: F, ) -> Result<Inner<C, J, X, V>, E>

Convert a node’s witness data to a different type.

impl<C, J, X: Disconnectable<C>, W> Inner<Arc<C>, J, X, W>

pub fn as_dag(&self) -> Dag<&C>

Collapse the node information to a Dag

impl<C, J, X, W> Inner<Option<C>, J, X, W>

pub fn transpose(self) -> Option<Inner<C, J, X, W>>

Convert an Inner<Option<C>, J, W> to an Option<Inner<C, J, W>>.

impl<C, J, X, W> Inner<C, J, Option<X>, W>

pub fn transpose_disconnect(self) -> Option<Inner<C, J, X, W>>

Convert an Inner<Option<C>, J, W> to an Option<Inner<C, J, W>>.

impl<C, J, X, W> Inner<C, J, X, Option<W>>

pub fn transpose_witness(self) -> Option<Inner<C, J, X, W>>

Convert an Inner<C, J, Option<W>> to an Option<Inner<C, J, W>>.

impl<C, J: Clone, X, W: Copy> Inner<C, J, X, &W>

pub fn copy_witness(self) -> Inner<C, J, X, W>

Copies witness data.

Useful in conjunction with Inner::as_ref when you don’t want to take a reference to witness data.

impl<C, J: Clone, X: Copy, W> Inner<C, J, &X, W>

pub fn copy_disconnect(self) -> Inner<C, J, X, W>

Copies disconnect data.

Useful in conjunction with Inner::as_ref when you don’t want to take a reference to disconnect data.

Trait Implementations

impl<C: Clone, J: Clone, X: Clone, W: Clone> Clone for Inner<C, J, X, W>

fn clone(&self) -> Inner<C, J, X, W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug, J: Debug, X: Debug, W: Debug> Debug for Inner<C, J, X, W>

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

Formats the value using the given formatter.

impl<C, J: Display, X, W> Display for Inner<C, J, X, W>

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

Formats the value using the given formatter.

impl<C: Hash, J: Hash, X: Hash, W: Hash> Hash for Inner<C, J, X, W>

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<C: Ord, J: Ord, X: Ord, W: Ord> Ord for Inner<C, J, X, W>

fn cmp(&self, other: &Inner<C, J, X, W>) -> 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<C: PartialEq, J: PartialEq, X: PartialEq, W: PartialEq> PartialEq for Inner<C, J, X, W>

fn eq(&self, other: &Inner<C, J, X, W>) -> 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<C: PartialOrd, J: PartialOrd, X: PartialOrd, W: PartialOrd> PartialOrd for Inner<C, J, X, W>

fn partial_cmp(&self, other: &Inner<C, J, X, W>) -> 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<C: Eq, J: Eq, X: Eq, W: Eq> Eq for Inner<C, J, X, W>

impl<C, J, X, W> StructuralPartialEq for Inner<C, J, X, W>