Struct StorageArray

pub struct StorageArray<S: StorageType, const N: usize> { /* private fields */ }

Accessor for a storage-backed array.

Implementations

impl<S: StorageType, const N: usize> StorageArray<S, N>

pub const fn len(&self) -> usize

Gets the number of elements stored.

Although this type will always have the same length, this method is still provided for consistency with [StorageVec].

pub fn getter(&self, index: impl TryInto<usize>) -> Option<StorageGuard<'_, S>>

Gets an accessor to the element at a given index, if it exists. Note: the accessor is protected by a StorageGuard, which restricts its lifetime to that of &self.

pub fn setter( &mut self, index: impl TryInto<usize>, ) -> Option<StorageGuardMut<'_, S>>

Gets a mutable accessor to the element at a given index, if it exists. Note: the accessor is protected by a StorageGuardMut, which restricts its lifetime to that of &mut self.

pub fn get(&self, index: impl TryInto<usize>) -> Option<S::Wraps<'_>>

Gets the element at the given index, if it exists.

pub fn get_mut(&mut self, index: impl TryInto<usize>) -> Option<S::WrapsMut<'_>>

Gets a mutable accessor to the element at a given index, if it exists.

Trait Implementations

impl<S: Erase, const N: usize> Erase for StorageArray<S, N>

fn erase(&mut self)

Erase the value from persistent storage.

impl<const N: usize, S, T> From<&T> for StorageArray<S, N>

where T: Host + Clone + 'static, S: StorageType,

fn from(host: &T) -> Self

Converts to this type from the input type.

impl<S: StorageType, const N: usize> HostAccess for StorageArray<S, N>

fn vm(&self) -> &dyn Host

Provides access to the parametrized host of a contract, giving access to all the desired hostios from the user.

impl<S: StorageType, const N: usize> StorageType for StorageArray<S, N>

const REQUIRED_SLOTS: usize

The number of words this type must fill. For primitives this is always 0. For complex types requiring more than one inline word, set this to the total size.

type Wraps<'a> = StorageGuard<'a, StorageArray<S, N>> where Self: 'a

For primitive types, this is the type being stored. For collections, this is the StorageType being collected.

type WrapsMut<'a> = StorageGuardMut<'a, StorageArray<S, N>> where Self: 'a

Mutable accessor to the type being stored.

unsafe fn new(slot: U256, offset: u8, host: VM) -> Self

Where in persistent storage the type should live. Although useful for framework designers creating new storage types, most user programs shouldn’t call this. Note: implementations will have to be const once generic_const_exprs stabilizes.

fn load<'s>(self) -> Self::Wraps<'s>

Load the wrapped type, consuming the accessor. Note: most types have a get and/or getter, which don’t consume Self.

fn load_mut<'s>(self) -> Self::WrapsMut<'s>

Load the wrapped mutable type, consuming the accessor. Note: most types have a set and/or setter, which don’t consume Self.

const SLOT_BYTES: usize = 32usize

The number of bytes in a slot needed to represent the type. Must not exceed 32. For types larger than 32 bytes that are stored inline with a struct’s fields, set this to 32 and return the full size in StorageType::new.