Struct Type

pub struct Type { /* private fields */ }

Source or target type of a Simplicity expression.

Internally this type is essentially just a refcounted pointer; it is therefore quite cheap to clone, but be aware that cloning will not actually create a new independent type, just a second pointer to the first one.

Implementations

impl Type

pub fn free(ctx: &Context, name: String) -> Self

Return an unbound type with the given name

pub fn unit(ctx: &Context) -> Self

Create the unit type.

pub fn two_two_n(ctx: &Context, n: usize) -> Self

Create the type 2^(2^n) for the given n.

The type is precomputed and fast to access.

pub fn sum(ctx: &Context, left: Self, right: Self) -> Self

Create the sum of the given left and right types.

pub fn product(ctx: &Context, left: Self, right: Self) -> Self

Create the product of the given left and right types.

pub fn complete(ctx: &Context, final_data: Arc<Final>) -> Self

Create a complete type.

pub fn shallow_clone(&self) -> Type

Clones the Type.

This is the same as just calling .clone() but has a different name to emphasize that what’s being cloned is merely a ref-counted pointer.

pub fn tmr(&self) -> Option<Tmr>

Accessor for the TMR of this type, if it is final

pub fn final_data(&self) -> Option<Arc<Final>>

Accessor for the data of this type, if it is complete

pub fn is_final(&self) -> bool

Whether this type is known to be final

During type inference this may be false even though the type is, in fact, complete, since its children may have been unified to a complete type. To ensure a type is complete, call Type::finalize.

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

Attempts to finalize the type. Returns its TMR on success.

pub fn powers_of_two(ctx: &Context, n: usize) -> Vec<Self>

Return a vector containing the types 2^(2^i) for i from 0 to n-1.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.