Struct bincode_core::BufferWriter

pub struct BufferWriter<'a> { /* fields omitted */ }

An implementation of CoreWrite. This buffer writer will write data to a backing &mut [u8].

Implementations

impl<'a> BufferWriter<'a>

pub fn new(buffer: &'a mut [u8]) -> Self

Create a new writer with a backing buffer.

pub fn written_len(&self) -> usize

The bytes count written to the backing buffer.

pub fn written_buffer(&self) -> &[u8]

A slice of the buffer that is in this writer. This is equivalent to getting a slice of the original buffer with the range ..writer.written_len().

// These two statements are equivalent
let buffer_slice = &buffer[..writer.written_len() as usize];
let writer_slice = writer.written_buffer();

assert_eq!(buffer_slice, writer_slice);

Trait Implementations

impl CoreWrite for &mut BufferWriter<'_>

type Error = BufferWriterError

The error that this writer can encounter

fn write(&mut self, val: u8) -> Result<(), Self::Error>

Write a single byte to the writer. This is assumed to be blocking, if the underlying writer is non-blocking, the value should be written to a backing buffer instead.

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

Flush the writer. This should empty any backing buffer and ensure all data is transferred. This function should block until all data is flushed.

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

Helper function to write multiple bytes to a writer. The default implementation calls write with each byte in the slice.

impl CoreWrite for BufferWriter<'_>

type Error = BufferWriterError

The error that this writer can encounter

fn write(&mut self, val: u8) -> Result<(), Self::Error>

Write a single byte to the writer. This is assumed to be blocking, if the underlying writer is non-blocking, the value should be written to a backing buffer instead.

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

Flush the writer. This should empty any backing buffer and ensure all data is transferred. This function should block until all data is flushed.

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

Helper function to write multiple bytes to a writer. The default implementation calls write with each byte in the slice.