Struct ic_kit::stable::StableWriter

pub struct StableWriter { /* private fields */ }

A writer to the stable memory.

Will attempt to grow the memory as it writes, and keep offsets and total capacity.

Implementations

impl StableWriter

pub fn new(offset: StableSize) -> Self

Create a new stable writer that writes from the given offset forward.

pub fn offset(&self) -> StableSize

Returns the current offset of the writer.

pub fn grow(&mut self, added_pages: StableSize) -> Result<(), StableMemoryError>

Attempts to grow the memory by adding new pages.

pub fn write(&mut self, buf: &[u8]) -> Result<usize, StableMemoryError>

Writes a byte slice to the buffer.

The only condition where this will error out is if it cannot grow the memory.

Trait Implementations

impl Default for StableWriter

fn default() -> Self

Returns the “default value” for a type.

impl Write for StableWriter

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adapter for this instance of Write.