Skip to main content

StorageMap

miden_base

Struct StorageMap 

Source 
pub struct StorageMap<K: WordKey, V: WordValue> {
    pub slot: StorageSlotId,
    /* private fields */
}
Expand description

Typed access to an account storage map.

Fields§

§slot: StorageSlotId

The underlying storage slot id.

Implementations§

Source§

impl<K: WordKey, V: WordValue> StorageMap<K, V>

Source

pub const fn new(slot: StorageSlotId) -> Self

Creates a new typed storage map handle for slot.

Source§

impl<K: WordKey, V: WordValue> StorageMap<K, V>

Source

pub fn get(&self, key: K) -> V

Returns the value associated with key from the account storage map.

Note: Unlike HashMap::get, this returns V by value. At the protocol layer, absent keys read as the default word value.

Source

pub fn set(&mut self, key: K, value: V) -> V

Sets value for key in the account storage map and returns the previous value.

This is analogous to HashMap::insert, except it always returns a value (the protocol does not distinguish “missing” from “default”).

Trait Implementations§

Source§

impl<K: Clone + WordKey, V: Clone + WordValue> Clone for StorageMap<K, V>

Source§

fn clone(&self) -> StorageMap<K, V>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Copy + WordKey, V: Copy + WordValue> Copy for StorageMap<K, V>

Source§

impl<K: Debug + WordKey, V: Debug + WordValue> Debug for StorageMap<K, V>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: Eq + WordKey, V: Eq + WordValue> Eq for StorageMap<K, V>

Source§

impl<K: WordKey, V: WordValue> From<StorageSlotId> for StorageMap<K, V>

Source§

fn from(slot: StorageSlotId) -> Self

Converts to this type from the input type.
Source§

impl<K: PartialEq + WordKey, V: PartialEq + WordValue> PartialEq for StorageMap<K, V>

Source§

fn eq(&self, other: &StorageMap<K, V>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<K: PartialEq + WordKey, V: PartialEq + WordValue> StructuralPartialEq for StorageMap<K, V>

Auto Trait Implementations§

§

impl<K, V> Freeze for StorageMap<K, V>
where PhantomData<(K, V)>: Freeze,

§

impl<K, V> RefUnwindSafe for StorageMap<K, V>
where PhantomData<(K, V)>: RefUnwindSafe,

§

impl<K, V> Send for StorageMap<K, V>
where PhantomData<(K, V)>: Send,

§

impl<K, V> Sync for StorageMap<K, V>
where PhantomData<(K, V)>: Sync,

§

impl<K, V> Unpin for StorageMap<K, V>
where PhantomData<(K, V)>: Unpin,

§

impl<K, V> UnsafeUnpin for StorageMap<K, V>
where PhantomData<(K, V)>: UnsafeUnpin,

§

impl<K, V> UnwindSafe for StorageMap<K, V>
where PhantomData<(K, V)>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Dup for T
where T: Copy + Clone,

Source§

fn dup(&self) -> T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more