Enum StateValue 

#[non_exhaustive]
pub enum StateValue<D = InMemoryDB>
where
    D: DB,
{
    Null,
    Cell(Sp<AlignedValue, D>),
    Map(HashMap<AlignedValue, StateValue<D>, D>),
    Array(Array<StateValue<D>, D>),
    BoundedMerkleTree(MerkleTree<(), D>),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

Cell(Sp<AlignedValue, D>)

Map(HashMap<AlignedValue, StateValue<D>, D>)

Array(Array<StateValue<D>, D>)

A fixed size array, with 0 <= len <= 16. The upper 5 bits of the argument to the new opcode specify the length at creation time. The underlying storage::Array type is not fixed length, but in the VM we only allow size preserving operations.

BoundedMerkleTree(MerkleTree<(), D>)

Merkle tree with 0 < height <= 32.

Implementations

impl<D> StateValue<D>

where D: DB,

pub fn log_size(&self) -> usize

Trait Implementations

impl<D> Clone for StateValue<D>

where D: DB,

fn clone(&self) -> StateValue<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D> Debug for StateValue<D>

where D: DB,

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

Formats the value using the given formatter.

impl<D> Default for StateValue<D>

where D: DB,

fn default() -> StateValue<D>

Returns the “default value” for a type.

impl<D> Deserializable for StateValue<D>

where D: DB,

fn deserialize( __reader: &mut impl Read, recursion_depth: u32, ) -> Result<StateValue<D>, Error>

const LIMIT_RECURSION: bool = true

fn check_rec(depth: &mut u32) -> Result<(), Error>

impl<'de, D1> Deserialize<'de> for StateValue<D1>

where D1: DB,

fn deserialize<D>( de: D, ) -> Result<StateValue<D1>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D> Drop for StateValue<D>

where D: DB,

fn drop(&mut self)

Executes the destructor for this type.

impl<D> FieldRepr for StateValue<D>

where D: DB,

fn field_repr<W>(&self, writer: &mut W)

where W: MemWrite<Fr>,

Writes out self as a sequence of Fr elements. As a general rule of thumb, this should usually produces a known number of elements.

fn field_size(&self) -> usize

The size of a value when represented as field elements.

fn field_vec(&self) -> Vec<Fr>

Writes the hash repr into a vector

impl<D> From<AlignedValue> for StateValue<D>

where D: DB,

fn from(val: AlignedValue) -> StateValue<D>

Converts to this type from the input type.

impl<D> From<u64> for StateValue<D>

where D: DB,

fn from(value: u64) -> StateValue<D>

Converts to this type from the input type.

impl<D> Hash for StateValue<D>

where D: DB,

fn hash<__H>(&self, __state: &mut __H)

where __H: Hasher,

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<D> Ord for StateValue<D>

where D: DB,

fn cmp(&self, __other: &StateValue<D>) -> 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<D> PartialEq for StateValue<D>

where D: DB,

fn eq(&self, __other: &StateValue<D>) -> 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<D> PartialOrd for StateValue<D>

where D: DB,

fn partial_cmp(&self, __other: &StateValue<D>) -> 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<D> Serializable for StateValue<D>

where D: DB,

fn serialize(&self, __writer: &mut impl Write) -> Result<(), Error>

fn serialized_size(&self) -> usize

impl<D> Serialize for StateValue<D>

where D: DB,

fn serialize<S>( &self, ser: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<D> StateValueExt<D> for StateValue<D>

where D: DB,

fn as_cell(&self) -> Result<Sp<AlignedValue, D>, OnchainProgramError<D>>

fn as_cell_ref(&self) -> Result<&AlignedValue, OnchainProgramError<D>>

impl<D> Storable<D> for StateValue<D>

where D: DB,

fn children(&self) -> Vec<ArenaKey<<D as DB>::Hasher>>

Provides an iterator over hashes of child Sps, if any. These hashes will be passed back into from_binary_repr when deserializing.

fn to_binary_repr<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

Serializes self, omitting any children.

fn from_binary_repr<R>( reader: &mut R, child_hashes: &mut impl Iterator<Item = ArenaKey<<D as DB>::Hasher>>, loader: &impl Loader<D>, ) -> Result<StateValue<D>, Error>

where R: Read,

Instantiates self, given hashes of any children, and loader that loads children given their hash.

fn check_invariant(&self) -> Result<(), Error>

An invariant to check on deserialization. Should be invoked from within from_binary_repr.

fn as_child(&self) -> ArenaKey<<D as DB>::Hasher>

Represents self as a ArenaKey

impl<D> Tagged for StateValue<D>

where D: DB,

fn tag() -> Cow<'static, str>

Retrieves the tag of Self. Returns a [Cow] as type arguments require allocation, but no allocation is preferred.

fn tag_unique_factor() -> String

A decomposition of this tag into primitive types (any type whose representation is not defined through other types), tuples (via (a,b)), and sum types (via [a,b]).

impl<D> Eq for StateValue<D>

where D: DB,