Struct simplicity::types::arrow::Arrow

pub struct Arrow {
    pub source: Type,
    pub target: Type,
}

A container for an expression’s source and target types, whether or not these types are complete.

Fields

source: Type

The source type

target: Type

The target type

Implementations

impl Arrow

pub fn finalize(&self) -> Result<FinalArrow, Error>

Finalize the source and target types in the arrow

pub fn for_unit() -> Self

Create a unification arrow for a fresh unit combinator

pub fn for_iden() -> Self

Create a unification arrow for a fresh iden combinator

pub fn for_witness() -> Self

Create a unification arrow for a fresh witness combinator

pub fn for_fail() -> Self

Create a unification arrow for a fresh fail combinator

pub fn for_jet<J: Jet>(jet: J) -> Self

Create a unification arrow for a fresh jet combinator

pub fn for_const_word(word: &Value) -> Self

Create a unification arrow for a fresh const-word combinator

pub fn for_injl(child_arrow: &Arrow) -> Self

Create a unification arrow for a fresh injl combinator

pub fn for_injr(child_arrow: &Arrow) -> Self

Create a unification arrow for a fresh injr combinator

pub fn for_take(child_arrow: &Arrow) -> Self

Create a unification arrow for a fresh take combinator

pub fn for_drop(child_arrow: &Arrow) -> Self

Create a unification arrow for a fresh drop combinator

pub fn for_pair( lchild_arrow: &Arrow, rchild_arrow: &Arrow ) -> Result<Self, Error>

Create a unification arrow for a fresh pair combinator

pub fn for_comp( lchild_arrow: &Arrow, rchild_arrow: &Arrow ) -> Result<Self, Error>

Create a unification arrow for a fresh comp combinator

pub fn for_case( lchild_arrow: Option<&Arrow>, rchild_arrow: Option<&Arrow> ) -> Result<Self, Error>

Create a unification arrow for a fresh case combinator

Either child may be None, in which case the combinator is assumed to be an assertion, which for type-inference purposes means there are no bounds on the missing child.

If neither child is provided, this function will not raise an error; it is the responsibility of the caller to detect this case and error elsewhere.

pub fn for_disconnect( lchild_arrow: &Arrow, rchild_arrow: &Arrow ) -> Result<Self, Error>

Create a unification arrow for a fresh comp combinator

pub fn shallow_clone(&self) -> Self

Same as Self::clone but named to make it clearer that this is cheap

Trait Implementations

impl Clone for Arrow

fn clone(&self) -> Arrow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoreConstructible for Arrow

fn iden() -> Self

fn unit() -> 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, _: Cmr) -> Result<Self, Error>

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

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

fn fail(_: FailEntropy) -> Self

fn const_word(word: Arc<Value>) -> Self

fn scribe(value: &Value) -> Self

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

fn bit_false() -> Self

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

fn bit_true() -> 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 Debug for Arrow

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

Formats the value using the given formatter.

impl DisconnectConstructible<Arrow> for Arrow

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

impl DisconnectConstructible<NoDisconnect> for Arrow

fn disconnect(left: &Self, _: &NoDisconnect) -> Result<Self, Error>

impl DisconnectConstructible<Option<&Arrow>> for Arrow

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

impl Display for Arrow

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

Formats the value using the given formatter.

impl<J: Jet> JetConstructible<J> for Arrow

fn jet(jet: J) -> Self

impl<W> WitnessConstructible<W> for Arrow

fn witness(_: W) -> Self