Struct StorageMapKey 

pub struct StorageMapKey(/* private fields */);

A raw, user-chosen key for a StorageMap.

Storage map keys are user-chosen and thus not necessarily uniformly distributed. To mitigate potential tree imbalance, keys are hashed before being inserted into the underlying SMT.

Use StorageMapKey::hash to produce the corresponding StorageMapKeyHash that is used in the SMT.

Implementations

impl StorageMapKey

pub fn from_raw(word: Word) -> Self

Construct without further checks from a given Word

Warning

This requires the caller to uphold the guarantees/invariants of this type (if any). Check the type-level documentation for guarantees/invariants.

pub fn as_elements(&self) -> &[Felt]

Returns the elements representation of this value.

pub fn as_bytes(&self) -> [u8; 32]

Returns the byte representation of this value.

pub fn to_hex(&self) -> String

Returns a big-endian, hex-encoded string.

pub fn as_word(&self) -> Word

Returns the underlying word of this value.

impl StorageMapKey

pub const SERIALIZED_SIZE: usize = Word::SERIALIZED_SIZE

The serialized size of the map key in bytes.

pub fn new(word: Word) -> Self

Creates a new StorageMapKey from the given word.

pub fn empty() -> Self

Returns the storage map key based on an empty word.

pub fn from_index(idx: u32) -> Self

Creates a StorageMapKey from a u32 index.

This is a convenience constructor for the common pattern of using sequential indices as storage map keys, producing a key of [idx, 0, 0, 0].

pub fn hash(&self) -> StorageMapKeyHash

Hashes this raw map key to produce a StorageMapKeyHash.

Storage map keys are hashed before being inserted into the SMT to ensure a uniform key distribution.

Trait Implementations

impl Clone for StorageMapKey

fn clone(&self) -> StorageMapKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageMapKey

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

Formats the value using the given formatter.

impl Deserializable for StorageMapKey

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Display for StorageMapKey

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

Formats the value using the given formatter.

impl From<StorageMapKey> for StorageMapKeyHash

fn from(key: StorageMapKey) -> Self

Converts to this type from the input type.

impl From<StorageMapKey> for Word

fn from(key: StorageMapKey) -> Self

Converts to this type from the input type.

impl Ord for StorageMapKey

fn cmp(&self, other: &StorageMapKey) -> 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 PartialEq for StorageMapKey

fn eq(&self, other: &StorageMapKey) -> 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 PartialOrd for StorageMapKey

fn partial_cmp(&self, other: &StorageMapKey) -> 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 Serializable for StorageMapKey

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Copy for StorageMapKey

impl Eq for StorageMapKey

impl StructuralPartialEq for StorageMapKey