Struct Hiding

pub struct Hiding<N> { /* private fields */ }

Wrapper that allows a node to be “hidden” during program construction.

Program construction

When a program is constructed in post-order, the parent node is created based on its children. We use this fact to introduce special branching logic:

1. A case node with a left “hidden” child and a right non-hidden child becomes assertr.
2. A case node with a left non-hidden child and a right “hidden” child becomes assertl.
3. Otherwise, any node with “hidden” children becomes itself “hidden” with an updated CMR.
4. Any node with non-hidden children remains unchanged.

The program can be extracted from the wrapper when construction is finished. The program is invalid if the root node is “hidden”.

Wrapping

A node can be wrapped via Hiding::from to add hiding support. A wrapped node can be converted into a “hidden” node via Hiding::hide. Finally, a “hidden” node can be manually created via Hiding::hidden.

Virtual hidden nodes

The wrapper merely simulates hidden nodes. At no point are actual hidden nodes created. To stress this fact, I write “hidden” in quotation marks.

Implementations

impl<N> Hiding<N>

pub const fn hidden(cmr: Cmr, ctx: Context) -> Self

Create a “hidden” node with the given CMR.

To enable the construction of possible parent nodes, the inference context of the current program must be passed.

pub fn as_node(&self) -> Option<&N>

Access the non-hidden node inside in the wrapper.

Return None if the wrapped node is “hidden”.

pub fn get_node(self) -> Option<N>

Consume the wrapper and return the non-hidden node that was inside.

Return None if the wrapped node is “hidden”.

impl<N: HasCmr> Hiding<N>

pub fn hide(self) -> Self

Ensure that the wrapped node is “hidden”. Convert non-hidden nodes into “hidden” nodes with the same CMR.

Trait Implementations

impl<N: Clone> Clone for Hiding<N>

fn clone(&self) -> Hiding<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: CoreConstructible + HasCmr> CoreConstructible for Hiding<N>

fn iden(inference_context: &Context) -> Self

fn unit(inference_context: &Context) -> Self

fn injl(child: &Self) -> Self

fn injr(child: &Self) -> Self

fn take(child: &Self) -> Self

fn drop_(child: &Self) -> Self

fn comp(left: &Self, right: &Self) -> Result<Self, Error>

fn case(left: &Self, right: &Self) -> Result<Self, Error>

fn assertl(left: &Self, right: Cmr) -> Result<Self, Error>

fn assertr(left: Cmr, right: &Self) -> Result<Self, Error>

fn pair(left: &Self, right: &Self) -> Result<Self, Error>

fn fail(inference_context: &Context, entropy: FailEntropy) -> Self

fn const_word(inference_context: &Context, word: Word) -> Self

fn inference_context(&self) -> &Context

Accessor for the type inference context used to create the object.

fn scribe(ctx: &Context, value: &Value) -> Self

Create an expression that produces the given value.

fn bit_false(inference_context: &Context) -> Self

Create a DAG that takes any input and returns bit 0 as constant output.

fn bit_true(inference_context: &Context) -> Self

Create a DAG that takes any input and returns bit 1 as constant output.

fn cond(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that takes a bit and an input, such that the left child is evaluated on the input if the bit is 1 (if branch) and the right child is evaluated on the input otherwise (else branch).

fn assert(child: &Self, hash: Cmr) -> Result<Self, Error>

Create a DAG that asserts that its child returns true, and fails otherwise. The hash identifies the assertion and is returned upon failure.

fn not(child: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean NOT of the child.

fn and(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean AND of the left and right child.

fn or(left: &Self, right: &Self) -> Result<Self, Error>

Create a DAG that computes Boolean OR of the left and right.

impl<N: Debug> Debug for Hiding<N>

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

Formats the value using the given formatter.

impl<X, N> DisconnectConstructible<Option<X>> for Hiding<N>

where N: DisconnectConstructible<Option<X>> + CoreConstructible + HasCmr,

fn disconnect(left: &Self, right: &Option<X>) -> Result<Self, Error>

impl<N: CoreConstructible> From<N> for Hiding<N>

fn from(node: N) -> Self

Converts to this type from the input type.

impl<N: HasCmr> HasCmr for Hiding<N>

fn cmr(&self) -> Cmr

Access the Commitment Merkle Root.

impl<J, N> JetConstructible<J> for Hiding<N>

where N: JetConstructible<J> + CoreConstructible,

fn jet(inference_context: &Context, jet: J) -> Self

impl<N: PartialEq> PartialEq for Hiding<N>

fn eq(&self, other: &Hiding<N>) -> 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<W, N> WitnessConstructible<W> for Hiding<N>

where N: WitnessConstructible<W> + CoreConstructible,

fn witness(inference_context: &Context, witness: W) -> Self

impl<N: Eq> Eq for Hiding<N>

impl<N> StructuralPartialEq for Hiding<N>