Struct StorageMapKeyHash 

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

A hashed key for a StorageMap.

This is produced by hashing a StorageMapKey and is used as the actual key in the underlying SMT. Wrapping the hashed key in a distinct type prevents accidentally using a raw key where a hashed key is expected and vice-versa.

Implementations

impl StorageMapKeyHash

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 StorageMapKeyHash

pub fn to_leaf_index(&self) -> LeafIndex<SMT_DEPTH>

Returns the leaf index in the SMT for this hashed key.

Trait Implementations

impl Clone for StorageMapKeyHash

fn clone(&self) -> StorageMapKeyHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageMapKeyHash

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<StorageMapKeyHash> for Word

fn from(key: StorageMapKeyHash) -> Self

Converts to this type from the input type.

impl Ord for StorageMapKeyHash

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

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

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

impl Eq for StorageMapKeyHash

impl StructuralPartialEq for StorageMapKeyHash