Skip to main content

StableVec

Struct StableVec 

Source
pub struct StableVec<T: Storable, M: Memory = DefaultMemoryImpl> { /* private fields */ }
Expand description

StableVec

ICSS-baseline fixed-stride vector in one governed allocation. There are no custom checksums, cached length, read windows or mutation epochs. Malformed stored values trap; IC execution rollback supplies atomicity.

Implementations§

Source§

impl<T: Storable, M: Memory> StableVec<T, M>

Source

pub fn create(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Create only in empty admitted memory.

§Errors

Refuses nonempty memory or initial growth refusal.

Source

pub fn reset(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Explicitly replace this vector image.

§Errors

Refuses initial growth; invalid bounds/codecs trap.

Source

pub fn load(memory: RuntimeMemory<M>) -> Result<Self, CollectionError>

Load the current SVC format without initialization.

§Errors

Refuses empty/foreign framing; engine/codec failures trap.

Source

pub fn get(&self, index: u64) -> Result<Option<T>, CollectionError>

Read one indexed record; malformed stored bytes trap.

§Errors

Engine failures trap instead of returning an ordinary error.

Source

pub fn set(&self, index: u64, item: &T) -> Result<(), CollectionError>

Replace one record; invalid codecs, bounds or writes trap.

§Errors

Engine failures trap instead of returning an ordinary error.

Source

pub fn push(&self, item: &T) -> Result<(), CollectionError>

Append one record, publishing its length last.

§Errors

Engine failures trap instead of returning an ordinary error.

Source

pub fn pop(&self) -> Result<Option<T>, CollectionError>

Remove the final record; failures trap.

§Errors

Engine failures trap instead of returning an ordinary error.

Source

pub fn len(&self) -> u64

Read the current committed length from stable memory.

Source

pub fn is_empty(&self) -> bool

Whether there are no records.

Source

pub fn iter( &self, ) -> impl DoubleEndedIterator<Item = Result<T, CollectionError>> + '_

Bidirectional iteration with one reusable buffer. Direct skips and last() decode only the selected record; they do not validate discarded records.

Auto Trait Implementations§

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !RefUnwindSafe for StableVec<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !Send for StableVec<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !Sync for StableVec<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !UnwindSafe for StableVec<T, M>

§

impl<T, M> Forget for StableVec<T, M>

§

impl<T, M> Freeze for StableVec<T, M>
where Vec<Codec<T>, Backing<RuntimeMemory<M>>>: Freeze,

§

impl<T, M> Unpin for StableVec<T, M>
where Vec<Codec<T>, Backing<RuntimeMemory<M>>>: Unpin,

§

impl<T, M> UnsafeUnpin for StableVec<T, M>
where Vec<Codec<T>, Backing<RuntimeMemory<M>>>: UnsafeUnpin,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.