Struct SliceWriter

pub struct SliceWriter<'a> {
    pub buf: &'a mut [u8],
    pub len: usize,
}

A simple slice writer (example implementation)

Fields

buf: &'a mut [u8]

len: usize

Implementations

impl<'a> SliceWriter<'a>

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

Create a new instance

pub fn len(&self) -> usize

Return populated length

pub fn is_empty(&self) -> bool

Return whether the output is not populated.

pub fn capacity(&self) -> usize

Return total capacity of the container

pub fn rem_capacity(&self) -> usize

Return remaining free capacity

pub fn clear(&mut self)

Reset cursor to the beginning of a container slice

pub fn split(self) -> (&'a mut [u8], Self)

Split the underlying buffer and return the portion of the populated buffer with an underlying buffer’s borrowed lifetime.

Once a SliceWriter is dropped the slice stays borrowed as long as the original container lives.

Trait Implementations

impl<'a> AsMut<[u8]> for SliceWriter<'a>

fn as_mut(&mut self) -> &mut [u8]

Returns a populated portion of the slice

impl<'a> AsRef<[u8]> for SliceWriter<'a>

fn as_ref(&self) -> &[u8]

Returns a populated portion of the slice

impl<'a> Debug for SliceWriter<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for SliceWriter<'a>

fn eq(&self, other: &SliceWriter<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SerWrite for SliceWriter<'_>

type Error = SerError

An error type returned from the trait methods.

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

Write all bytes from buf to the internal buffer.

fn write_byte(&mut self, byte: u8) -> Result<(), Self::Error>

Write a single byte to the internal buffer.

fn write_str(&mut self, s: &str) -> Result<(), Self::Error>

Write a whole string to the internal buffer.

impl<'a> Write for SliceWriter<'a>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

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

Glue for usage of the write! macro with implementors of this trait.

impl<'a> StructuralPartialEq for SliceWriter<'a>