Struct Value

Source

pub struct Value { /* private fields */ }

Expand description

A Simplicity value.

Implementations§

Source §

impl Value

Source

pub fn shallow_clone(&self) -> Self

Make a cheap copy of the value.

Source

pub fn ty(&self) -> &Final

Access the type of the value.

Source

pub fn unit() -> Self

Create the unit value.

Source

pub fn left(inner: Self, right: Arc<Final>) -> Self

Create a left value that wraps the given inner value.

Source

pub fn right(left: Arc<Final>, inner: Self) -> Self

Create a right value that wraps the given inner value.

Source

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

Create a product value that wraps the given left and right values.

Source

pub fn none(right: Arc<Final>) -> Self

Create a none value.

Source

pub fn some(inner: Self) -> Self

Create a some value.

Source

pub fn buffer8_two_n_plus_one( n: usize, data: &[u8], ) -> Result<Self, Buffer8Error>

Create a value of the type (TWO^8)^<2^(n+1) for the given n, populated with the given slice’s data.

This type represents “a variable-length buffer of maximum length 2^(n+1) - 1”. So for example, setting n = 5, the buffer can hold up to 63 bytes.

Source

pub fn ctx8( midstate: [u8; 32], bytes_hashed: u64, buffer: &[u8], ) -> Result<Self, Buffer8Error>

Constructs a Ctx8 from raw parts.

Bear in mind that the count is a count of bytes, not a count of bits. For the context to be valid (i.e. something that could be obtained by a sequence of hashing operations), bytes_hashed % 64 must equal buffer.len().

You may want to obtain a hash engine and call Self::ctx8_from_hash_engine instead.

§Errors

Errors if the buffer exceeds the maximum length of a sha256 buffer (63 bytes).

Source

pub fn ctx8_from_midstate(midstate: Midstate) -> Self

Converts a SHA256 midstate into a Simplicity value.

Source

pub fn ctx8_from_hash_engine(engine: &HashEngine) -> Self

Converts a SHA256 engine into a Simplicity value.

Source

pub fn compact_len(&self) -> usize

Return the bit length of the value in compact encoding.

Source

pub fn padded_len(&self) -> usize

Return the bit length of the value in padded encoding.

Source

pub fn is_empty(&self) -> bool

Check if the value is a nested product of units. In this case, the value contains no information.

Source

pub fn is_unit(&self) -> bool

Check if the value is a unit.

Source

pub fn as_ref(&self) -> ValueRef<'_>

A reference to this value, which can be recursed over.

Source

pub fn as_left(&self) -> Option<ValueRef<'_>>

Access the inner value of a left sum value.

Source

pub fn as_right(&self) -> Option<ValueRef<'_>>

Access the inner value of a right sum value.

Source

pub fn as_product(&self) -> Option<(ValueRef<'_>, ValueRef<'_>)>

Access the inner values of a product value.

Source

pub fn u1(value: u8) -> Self

Create a 1-bit integer.

§Panics

The value is out of range.

Source

pub fn u2(value: u8) -> Self

Create a 2-bit integer.

§Panics

The value is out of range.

Source

pub fn u4(value: u8) -> Self

Create a 4-bit integer.

§Panics

The value is ouf of range.

Source

pub fn u8(value: u8) -> Self

Create an 8-bit integer.

Source

pub fn u16(bytes: u16) -> Self

Create a 16-bit integer.

Source

pub fn u32(bytes: u32) -> Self

Create a 32-bit integer.

Source

pub fn u64(bytes: u64) -> Self

Create a 64-bit integer.

Source

pub fn u128(bytes: u128) -> Self

Create a 128-bit integer.

Source

pub fn u256(bytes: [u8; 32]) -> Self

Create a 256-bit integer.

Source

pub fn u512(bytes: [u8; 64]) -> Self

Create a 512-bit integer.

Source

pub fn from_byte_array<const N: usize>(bytes: [u8; N]) -> Self

Create a value from a byte array.

§Panics

The array length is not a power of two.

Source

pub fn raw_byte_iter(&self) -> RawByteIter<'_>

Yields an iterator over the “raw bytes” of the value.

The returned bytes match the padded bit-encoding of the value. You may wish to call Self::iter_padded instead to obtain the bits, but this method is more efficient in some contexts.

Source

pub fn iter_compact(&self) -> CompactBitsIter<'_>

Return an iterator over the compact bit encoding of the value.

This encoding is used for writing witness data and for computing IHRs.

Source

pub fn iter_padded(&self) -> PreOrderIter<'_>

Return an iterator over the padded bit encoding of the value.

This encoding is used to represent the value in the Bit Machine.

Source

pub fn is_of_type(&self, ty: &Final) -> bool

Check if the value is of the given type.

Source

pub fn zero(ty: &Final) -> Self

Get the zero value for the given type.

The zero value serializes to a string of zeroes.

§Construction

zero( 1 ) = ()
zero( A + B ) = zero(A)
zero( A × B ) = zero(A) × zero(B)

Source

pub fn to_word(&self) -> Option<Word>

Try to convert the value into a word.

The value is cheaply cloned.

Source

pub fn prune(&self, pruned_ty: &Final) -> Option<Self>

Prune the value down to the given type.

The pruned type must be smaller than or equal to the current type of the value. Otherwise, this method returns None.

§Smallness

T ≤ T for all types T
1 ≤ T for all types T
A1 + B1 ≤ A2 + B2 if A1 ≤ A2 and B1 ≤ B2
A1 × B1 ≤ A2 × B2 if A1 ≤ A2 and B1 ≤ B2

§Pruning

prune( v: T, 1 ) = (): 1
prune( L(l): A1 + B1, A2 + B2 ) = prune(l: A1, A2) : A2 + B2
prune( R(r): A1 + B1, A2 + B2 ) = prune(r: B1, B2) : A2 + B2
prune( (l, r): A1 × B1, A2 × B2 ) = ( prune(l: A1, A2), prune(r: B1, B2): A2 × B2