Struct secret_toolkit_storage::deque_store::DequeStoreMut

pub struct DequeStoreMut<'a, T, S, Ser = Bincode2> where
    T: Serialize + DeserializeOwned,
    S: Storage,
    Ser: Serde,  { /* private fields */ }

A type allowing both reads from and writes to the deque store at a given storage location.

Implementations

impl<'a, T, S> DequeStoreMut<'a, T, S, Bincode2> where
    T: Serialize + DeserializeOwned,
    S: Storage, 

pub fn attach_or_create(storage: &'a mut S) -> StdResult<Self>

Try to use the provided storage as an DequeStore. If it doesn’t seem to be one, then initialize it as one.

Returns Err if the contents of the storage can not be parsed.

pub fn attach(storage: &'a mut S) -> Option<StdResult<Self>>

Try to use the provided storage as an DequeStore.

Returns None if the provided storage doesn’t seem like an DequeStore. Returns Err if the contents of the storage can not be parsed.

impl<'a, T, S, Ser> DequeStoreMut<'a, T, S, Ser> where
    T: Serialize + DeserializeOwned,
    S: Storage,
    Ser: Serde, 

pub fn attach_or_create_with_serialization(
    storage: &'a mut S,
    _ser: Ser
) -> StdResult<Self>

Try to use the provided storage as an DequeStore. If it doesn’t seem to be one, then initialize it as one. This method allows choosing the serialization format you want to use.

Returns Err if the contents of the storage can not be parsed.

pub fn attach_with_serialization(
    storage: &'a mut S,
    _ser: Ser
) -> Option<StdResult<Self>>

Try to use the provided storage as an DequeStore. This method allows choosing the serialization format you want to use.

Returns None if the provided storage doesn’t seem like an DequeStore. Returns Err if the contents of the storage can not be parsed.

pub fn len(&self) -> u32

pub fn is_empty(&self) -> bool

pub fn storage(&mut self) -> &mut S

pub fn readonly_storage(&self) -> &S

pub fn iter(&self) -> Iter<'_, T, S, Ser>

Return an iterator over the items in the collection

pub fn get_at(&self, pos: u32) -> StdResult<T>

Get the value stored at a given position.

Errors

Will return an error if pos is out of bounds or if an item is not found.

pub fn set_at(&mut self, pos: u32, item: &T) -> StdResult<()>

Set the value of the item stored at a given position.

Errors

Will return an error if the position is out of bounds

pub fn push_back(&mut self, item: &T) -> StdResult<()>

Append an item to the end of the collection.

This operation has a constant cost.

pub fn push_front(&mut self, item: &T) -> StdResult<()>

Add an item to the begining of the collection.

This operation has a constant cost.

pub fn pop_back(&mut self) -> StdResult<T>

Pop the last item off the collection

This operation has a constant cost.

pub fn pop_front(&mut self) -> StdResult<T>

Pop the first item off the collection

This operation has a constant cost.

pub fn remove(&mut self, pos: u32) -> StdResult<T>

Remove an element from the collection at the specified position.

Removing an element from the head (first) or tail (last) has a constant cost. The cost of removing from the middle will depend on the proximity to the head or tail. In that case, all the elements between the closest tip of the collection (head or tail) and the specified position will be shifted in storage.

Removing an element from the middle of the collection has the worst runtime and gas cost.

pub fn clear(&mut self)

Clear the collection

Trait Implementations

impl<'a, T: Debug, S: Debug, Ser: Debug> Debug for DequeStoreMut<'a, T, S, Ser> where
    T: Serialize + DeserializeOwned,
    S: Storage,
    Ser: Serde, 

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

Formats the value using the given formatter.