Struct EmptyBuf

pub struct EmptyBuf;

An empty buffer.

An EmptyBuf is a buffer with 0 bytes of length or capacity. It implements all of the buffer traits (XxxBuffer and XxxBufferMut) and both buffer view traits (BufferView and BufferViewMut).

Trait Implementations

impl AsMut<[u8]> for EmptyBuf

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for EmptyBuf

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Buffer for EmptyBuf

fn parse_with_view<'a, ParseArgs, P: ParsablePacket<&'a [u8], ParseArgs>>( &'a mut self, args: ParseArgs, ) -> Result<(P, &'a [u8]), P::Error>

Like ParseBuffer::parse_with but additionally provides an un-structured view into the parsed data on successful parsing.

impl<'a> BufferView<&'a [u8]> for EmptyBuf

fn len(&self) -> usize

The length of the buffer’s body.

fn take_front(&mut self, n: usize) -> Option<&'a [u8]>

Takes n bytes from the front of the buffer’s body.

fn take_back(&mut self, n: usize) -> Option<&'a [u8]>

Takes n bytes from the back of the buffer’s body.

fn into_rest(self) -> &'a [u8]

Converts this view into a reference to the buffer’s body.

fn is_empty(&self) -> bool

Is the buffer’s body empty?

fn take_rest_front(&mut self) -> B

Takes the rest of the buffer’s body from the front.

fn take_rest_back(&mut self) -> B

Takes the rest of the buffer’s body from the back.

fn take_byte_front(&mut self) -> Option<u8>

Takes a single byte of the buffer’s body from the front.

fn take_byte_back(&mut self) -> Option<u8>

Takes a single byte of the buffer’s body from the back.

fn peek_obj_front<T>(&mut self) -> Option<&T>

where T: FromBytes + KnownLayout + Immutable + Unaligned,

Peeks at an object at the front of the buffer’s body.

fn take_obj_front<T>(&mut self) -> Option<Ref<B, T>>

where T: KnownLayout + Immutable + Unaligned,

Takes an object from the front of the buffer’s body.

fn take_slice_front<T>(&mut self, n: usize) -> Option<Ref<B, [T]>>

where T: Immutable + Unaligned,

Takes a slice of objects from the front of the buffer’s body.

fn peek_obj_back<T>(&mut self) -> Option<&T>

where T: FromBytes + KnownLayout + Immutable + Unaligned,

Peeks at an object at the back of the buffer’s body.

fn take_obj_back<T>(&mut self) -> Option<Ref<B, T>>

where T: Immutable + KnownLayout + Unaligned,

Takes an object from the back of the buffer’s body.

fn take_slice_back<T>(&mut self, n: usize) -> Option<Ref<B, [T]>>

where T: Immutable + Unaligned,

Takes a slice of objects from the back of the buffer’s body.

impl<'a> BufferView<&'a mut [u8]> for EmptyBuf

fn len(&self) -> usize

The length of the buffer’s body.

fn take_front(&mut self, n: usize) -> Option<&'a mut [u8]>

Takes n bytes from the front of the buffer’s body.

fn take_back(&mut self, n: usize) -> Option<&'a mut [u8]>

Takes n bytes from the back of the buffer’s body.

fn into_rest(self) -> &'a mut [u8]

Converts this view into a reference to the buffer’s body.

fn is_empty(&self) -> bool

Is the buffer’s body empty?

fn take_rest_front(&mut self) -> B

Takes the rest of the buffer’s body from the front.

fn take_rest_back(&mut self) -> B

Takes the rest of the buffer’s body from the back.

fn take_byte_front(&mut self) -> Option<u8>

Takes a single byte of the buffer’s body from the front.

fn take_byte_back(&mut self) -> Option<u8>

Takes a single byte of the buffer’s body from the back.

fn peek_obj_front<T>(&mut self) -> Option<&T>

where T: FromBytes + KnownLayout + Immutable + Unaligned,

Peeks at an object at the front of the buffer’s body.

fn take_obj_front<T>(&mut self) -> Option<Ref<B, T>>

where T: KnownLayout + Immutable + Unaligned,

Takes an object from the front of the buffer’s body.

fn take_slice_front<T>(&mut self, n: usize) -> Option<Ref<B, [T]>>

where T: Immutable + Unaligned,

Takes a slice of objects from the front of the buffer’s body.

fn peek_obj_back<T>(&mut self) -> Option<&T>

where T: FromBytes + KnownLayout + Immutable + Unaligned,

Peeks at an object at the back of the buffer’s body.

fn take_obj_back<T>(&mut self) -> Option<Ref<B, T>>

where T: Immutable + KnownLayout + Unaligned,

Takes an object from the back of the buffer’s body.

fn take_slice_back<T>(&mut self, n: usize) -> Option<Ref<B, [T]>>

where T: Immutable + Unaligned,

Takes a slice of objects from the back of the buffer’s body.

impl<'a> BufferViewMut<&'a mut [u8]> for EmptyBuf

fn take_front_zero(&mut self, n: usize) -> Option<B>

Takes n bytes from the front of the buffer’s body and zeroes them.

fn take_back_zero(&mut self, n: usize) -> Option<B>

Takes n bytes from the back of the buffer’s body and zeroes them.

fn take_rest_front_zero(self) -> B

Takes the rest of the buffer’s body from the front and zeroes it.

fn take_rest_back_zero(self) -> B

Takes the rest of the buffer’s body from the back and zeroes it.

fn into_rest_zero(self) -> B

Converts this view into a reference to the buffer’s body, and zeroes it.

fn take_obj_front_zero<T>(&mut self) -> Option<Ref<B, T>>

where T: KnownLayout + Immutable + Unaligned,

Takes an object from the front of the buffer’s body and zeroes it.

fn take_obj_back_zero<T>(&mut self) -> Option<Ref<B, T>>

where T: KnownLayout + Immutable + Unaligned,

Takes an object from the back of the buffer’s body and zeroes it.

fn write_obj_front<T>(&mut self, obj: &T) -> Option<()>

where T: ?Sized + IntoBytes + Immutable,

Writes an object to the front of the buffer’s body, consuming the bytes.

fn write_obj_back<T>(&mut self, obj: &T) -> Option<()>

where T: ?Sized + IntoBytes + Immutable,

Writes an object to the back of the buffer’s body, consuming the bytes.

impl Clone for EmptyBuf

fn clone(&self) -> EmptyBuf

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EmptyBuf

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

Formats the value using the given formatter.

impl FragmentedBuffer for EmptyBuf

fn len(&self) -> usize

Gets the total length, in bytes, of this FragmentedBuffer.

fn with_bytes<R, F>(&self, f: F) -> R

where F: for<'macro_a, 'macro_b> FnOnce(FragmentedBytes<'macro_a, 'macro_b>) -> R,

Invokes a callback on a view into this buffer’s contents as FragmentedBytes.

fn to_flattened_vec(&self) -> Vec<u8>

Returns a flattened version of this buffer, copying its contents into a Vec.

fn is_empty(&self) -> bool

Returns true if this FragmentedBuffer is empty.

impl FragmentedBufferMut for EmptyBuf

fn with_bytes_mut<R, F>(&mut self, f: F) -> R

where F: for<'macro_a, 'macro_b> FnOnce(FragmentedBytesMut<'macro_a, 'macro_b>) -> R,

Invokes a callback on a mutable view into this buffer’s contents as FragmentedBytesMut.

fn zero_range<R>(&mut self, range: R)

where R: RangeBounds<usize>,

Sets all bytes in range to zero.

fn copy_within<R: RangeBounds<usize>>(&mut self, src: R, dest: usize)

Copies elements from one part of the FragmentedBufferMut to another part of itself.

fn copy_from<B: FragmentedBuffer>(&mut self, other: &B)

Copies all the bytes from another FragmentedBuffer other into self.

impl GrowBuffer for EmptyBuf

fn with_parts<O, F>(&self, f: F) -> O

where F: for<'a, 'b> FnOnce(&'a [u8], FragmentedBytes<'a, 'b>, &'a [u8]) -> O,

Gets a view into the parts of this GrowBuffer.

fn grow_front(&mut self, n: usize)

Grows the front of the body towards Growf the buffer.

fn grow_back(&mut self, n: usize)

Grows the back of the body towards the end of the buffer.

fn capacity(&self) -> usize

The capacity of the buffer.

fn prefix_len(&self) -> usize

The length of the prefix.

fn suffix_len(&self) -> usize

The length of the suffix.

fn reset(&mut self)

Resets the body to be equal to the entire buffer.

fn undo_parse(&mut self, meta: ParseMetadata)

Undoes the effects of a previous parse in preparation for serialization.

impl GrowBufferMut for EmptyBuf

fn with_parts_mut<O, F>(&mut self, f: F) -> O

where F: for<'a, 'b> FnOnce(&'a mut [u8], FragmentedBytesMut<'a, 'b>, &'a mut [u8]) -> O,

Gets a mutable view into the parts of this GrowBufferMut.

fn grow_front_zero(&mut self, n: usize)

Extends the front of the body towards the beginning of the buffer, zeroing the new bytes.

fn grow_back_zero(&mut self, n: usize)

Extends the back of the body towards the end of the buffer, zeroing the new bytes.

fn reset_zero(&mut self)

Resets the body to be equal to the entire buffer, zeroing the new bytes.

impl ParseBuffer for EmptyBuf

fn parse_with<'a, ParseArgs, P: ParsablePacket<&'a [u8], ParseArgs>>( &'a mut self, args: ParseArgs, ) -> Result<P, P::Error>

Parses a packet with arguments.

fn parse<'a, P: ParsablePacket<&'a [u8], ()>>( &'a mut self, ) -> Result<P, P::Error>

Parses a packet from the body.

impl ParseBufferMut for EmptyBuf

fn parse_with_mut<'a, ParseArgs, P: ParsablePacket<&'a mut [u8], ParseArgs>>( &'a mut self, args: ParseArgs, ) -> Result<P, P::Error>

Parses a mutable packet with arguments.

fn parse_mut<'a, P: ParsablePacket<&'a mut [u8], ()>>( &'a mut self, ) -> Result<P, P::Error>

Parses a mutable packet from the body.

impl PartialEq for EmptyBuf

fn eq(&self, other: &EmptyBuf) -> 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 ShrinkBuffer for EmptyBuf

fn shrink_front(&mut self, n: usize)

Shrinks the front of the body towards the end of the buffer.

fn shrink_back(&mut self, n: usize)

Shrinks the back of the body towards the beginning of the buffer.

fn shrink_front_to(&mut self, len: usize)

Shrinks the buffer to be no larger than len bytes, consuming from the front.

fn shrink_back_to(&mut self, len: usize)

Shrinks the buffer to be no larger than len bytes, consuming from the back.

fn shrink<R: RangeBounds<usize>>(&mut self, range: R)

Shrinks the body.

impl ContiguousBuffer for EmptyBuf

impl Copy for EmptyBuf

impl Eq for EmptyBuf

impl StructuralPartialEq for EmptyBuf