Struct ic_stable_structures::writer::Writer

pub struct Writer<'a, M> { /* private fields */ }

A writer that writes sequentially to memory.

Warning: This will overwrite any existing data in stable memory as it writes, so ensure you set the offset value accordingly if you wish to preserve existing data.

The writer Will attempt to grow the memory as it writes.

Implementations

impl<'a, M: Memory> Writer<'a, M>

pub fn new(memory: &'a mut M, offset: u64) -> Self

Creates a new Writer which writes to the selected memory starting from the offset.

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

Writes a byte slice to the underlying memory directly.

Note: The writer will first attempt to grow the memory enough to write all the data and only then start writing. If the memory can not be grown sufficiently, the write is aborted without writing any data.

Trait Implementations

impl<'a, M: Memory> Write for Writer<'a, M>

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 Selfwhere
    Self: Sized,

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