Struct s2n_codec::encoder::buffer::EncoderBuffer

pub struct EncoderBuffer<'a> { /* private fields */ }

EncoderBuffer is a buffer for writing to a mutable slice

Implementations

impl<'a> EncoderBuffer<'a>

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

Creates a new EncoderBuffer

pub fn set_position(&mut self, position: usize)

Sets the write cursor to a new position

Panics

Panics when position > capacity

pub fn advance_position(&mut self, offset: usize)

Advances the write cursor by offset

Panics

Panics when position > capacity

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

Splits off the used buffer from the remaining bytes

pub fn split_mut(&mut self) -> (&mut [u8], &mut [u8])

Splits the used buffer from the remaining bytes

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns the written bytes as a mutable slice

Trait Implementations

impl<'a> Debug for EncoderBuffer<'a>

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

Formats the value using the given formatter.

impl<'a> Encoder for EncoderBuffer<'a>

fn write_sized<F: FnOnce(&mut [u8])>(&mut self, len: usize, write: F)

Calls write with a slice of len bytes at the current write position

fn write_slice(&mut self, slice: &[u8])

Copies the slice into the buffer

fn write_repeated(&mut self, count: usize, value: u8)

Repeatedly write a byte value for a given count

fn capacity(&self) -> usize

Returns the total buffer capacity

fn len(&self) -> usize

Returns the number of bytes written to the buffer

const SPECIALIZES_BYTES: bool = false

Set to true if the particular encoder specializes on the bytes implementation

fn encode<T: EncoderValue>(&mut self, value: &T)

Encode the given EncoderValue into the buffer

fn encode_with_len_prefix<Len: TryFrom<usize> + EncoderValue, T: EncoderValue>(
    &mut self,
    value: &T
)where
    Len::Error: Debug,

Encode the given EncoderValue into the buffer with a prefix of Len

fn write_bytes(&mut self, bytes: Bytes)

fn is_empty(&self) -> bool

Returns true if no bytes have been written

fn remaining_capacity(&self) -> usize

Returns the number of available bytes in the buffer

impl<'a> Ord for EncoderBuffer<'a>

fn cmp(&self, other: &EncoderBuffer<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<EncoderBuffer<'a>> for EncoderBuffer<'a>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd<EncoderBuffer<'a>> for EncoderBuffer<'a>

fn partial_cmp(&self, other: &EncoderBuffer<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for EncoderBuffer<'a>

impl<'a> StructuralEq for EncoderBuffer<'a>

impl<'a> StructuralPartialEq for EncoderBuffer<'a>