Struct BufferManager

pub struct BufferManager<'a, V> { /* private fields */ }

Implementations

impl<'a, V> BufferManager<'a, V>

where V: Serialize + DeserializeOwned + 'a,

pub fn init( store: &mut dyn Storage, store_iface: CircularBuffer<'a, V>, capacity: u32, ) -> BufferResult<()>

Static function to initialize buffer in storage. Intended to be called during contract initialization.

pub fn new( store: &dyn Storage, store_iface: CircularBuffer<'a, V>, ) -> BufferResult<Self>

Initialize buffer manager. In case buffer is not initialized it throws BufferError::BufferNotInitialized error.

pub fn capacity(&self) -> u32

Returns current buffer capacity.

pub fn head(&self) -> u32

Returns current buffer head.

pub fn push(&mut self, value: &'a V)

Push value to precommit buffer.

pub fn push_many(&mut self, values: &'a [V])

Push multiple values to precommit buffer.

pub fn instant_push( &mut self, store: &mut dyn Storage, value: &'a V, ) -> BufferResult<()>

Push value to precommit buffer and commit it to storage.

pub fn commit(&mut self, store: &mut dyn Storage) -> BufferResult<()>

Commit in storage current state and precommit buffer. Buffer is erased after commit.

pub fn read( &self, store: &dyn Storage, indexes: impl IntoIterator<Item = impl Into<u32> + Display>, stop_if_empty: bool, ) -> BufferResult<Vec<V>>

Read values from storage by indexes. If stop_if_empty is true, reading will stop when first empty value is encountered. Otherwise, BufferError::IndexNotFound error will be thrown.

Examples:

let values = buffer.read(&store, 0u32..=9, false).unwrap();
let values = buffer.read(&store, vec![0u32, 5, 7], false).unwrap();
let values = buffer.read(&store, (0u32..buffer.capacity()).step_by(2), false).unwrap();

pub fn read_all(&self, store: &dyn Storage) -> BufferResult<Vec<V>>

Read all available values from storage.

pub fn read_last(&self, store: &dyn Storage) -> BufferResult<Option<V>>

Read last saved value from storage. Returns None if buffer is empty.

pub fn read_single( &self, store: &dyn Storage, index: impl Into<u32>, ) -> BufferResult<Option<V>>

Looped read. Returns None if value in buffer does not exist.

pub fn clear_buffer(&self, store: &mut dyn Storage)

This operation is gas consuming. However, it might be helpful in rare cases.

pub fn exists(&self, store: &dyn Storage, index: u32) -> bool

Whether index exists in buffer.

Trait Implementations

impl<V: Debug> Debug for BufferManager<'_, V>

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

Formats the value using the given formatter.