Struct StableLog 

pub struct StableLog<T: Storable, M: Memory = DefaultMemoryImpl> { /* private fields */ }

Governed upstream Log; initialization and failures follow upstream contracts.

Implementations

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

pub fn new( index_memory: RuntimeMemory<M>, data_memory: RuntimeMemory<M>, ) -> Self

Create a new collection, replacing any prior collection in the selected memory. This is destructive even when a valid collection already exists.

Panics

Panics on insufficient memory or codec/backing failure.

pub fn init( index_memory: RuntimeMemory<M>, data_memory: RuntimeMemory<M>, ) -> Self

Open a retained log, or initialize both memories when data memory is empty or has foreign magic. The latter overwrites previous contents.

Panics

With recognized data magic, panics for an invalid index or unsupported layout. Growth and codec/backing failures also retain upstream panics.

pub fn first(&self) -> Option<T>

Delegates to upstream Log::first with the governed allocation.

pub fn last(&self) -> Option<T>

Delegates to upstream Log::last with the governed allocation.

pub fn get(&self, idx: u64) -> Option<T>

Delegates to upstream Log::get with the governed allocation.

pub fn len(&self) -> u64

Delegates to upstream Log::len with the governed allocation.

pub fn is_empty(&self) -> bool

Delegates to upstream Log::is_empty with the governed allocation.

pub fn append(&self, item: &T) -> Result<u64, LogWriteError>

Delegates to upstream Log::append with the governed allocation.

Errors

Returns the upstream write error if memory cannot grow.

pub fn iter(&self) -> LogIter<'_, T, M>

Delegates to upstream Log::iter with the governed allocation.

Trait Implementations

impl<'a, T: Storable, M: Memory> IntoIterator for &'a StableLog<T, M>

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T, RuntimeMemory<M>, RuntimeMemory<M>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.