Struct ink_storage::Memory

pub struct Memory<T> { /* fields omitted */ }

An instance that is solely stored within the contract's memory.

This will never be stored to or loaded from contract storage.

Note

Use instances of this type in order to have some shared state between contract messages and functions. Its usage is comparable to the Solidity's memory instances. Pulling an instance of this type from the contract storage will always yield a default constructed value.

Implementations

impl<T> Memory<T>

pub fn new(inner: T) -> Self

Creates a new memory instance.

pub fn get(memory: &Self) -> &T

Returns a shared reference to the inner T.

pub fn get_mut(memory: &mut Self) -> &mut T

Returns an exclusive reference to the inner T.

Trait Implementations

impl<T> AsMut<T> for Memory<T> where
    T: SpreadLayout, 

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

Performs the conversion.

impl<T> AsRef<T> for Memory<T> where
    T: SpreadLayout, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Borrow<T> for Memory<T> where
    T: SpreadLayout, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for Memory<T> where
    T: SpreadLayout, 

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

Mutably borrows from an owned value.

impl<T: Clone> Clone for Memory<T>

fn clone(&self) -> Memory<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Memory<T>

impl<T: Debug> Debug for Memory<T>

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

Formats the value using the given formatter.

impl<T> Default for Memory<T> where
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> Deref for Memory<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Memory<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for Memory<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Memory<T>

impl<T> From<T> for Memory<T>

fn from(inner: T) -> Self

Performs the conversion.

impl<T: Hash> Hash for Memory<T>

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Memory<T>

fn cmp(&self, other: &Memory<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Memory<T>> for Memory<T>

fn eq(&self, other: &Memory<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Memory<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Memory<T>> for Memory<T>

fn partial_cmp(&self, other: &Memory<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Memory<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Memory<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Memory<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Memory<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> SpreadLayout for Memory<T> where
    T: Default, 

const FOOTPRINT: u64

The footprint of the type.

fn pull_spread(_ptr: &mut KeyPtr) -> Self

Pulls an instance of Self from the contract storage.

fn push_spread(&self, _ptr: &mut KeyPtr)

Pushes an instance of Self to the contract storage.

fn clear_spread(&self, _ptr: &mut KeyPtr)

Clears an instance of Self from the contract storage.

const REQUIRES_DEEP_CLEAN_UP: bool

Indicates whether a type requires deep clean-up of its state meaning that a clean-up routine has to decode an entity into an instance in order to eventually recurse upon its tear-down. This is not required for the majority of primitive data types such as i32, however types such as storage::Box that might want to forward the clean-up procedure to their inner T require a deep clean-up.

impl<T> StorageLayout for Memory<T>

fn layout(key_ptr: &mut KeyPtr) -> Layout

Returns the static storage layout of Self.

impl<T> StructuralEq for Memory<T>

impl<T> StructuralPartialEq for Memory<T>