Struct packet::SliceBufViewMut

pub struct SliceBufViewMut<'a>(/* private fields */);

A BufferViewMut into a &mut [u8].

This type is useful for instantiating a mutable view into a slice that can be used for parsing, where any parsing that is done only affects this view and therefore need not be “undone” later.

Note that BufferViewMut<&mut [u8]> is also implemented for &mut &mut u8 (a mutable reference to a mutable byte slice), but this can be problematic if you need to materialize an owned type that implements BufferViewMut, in order to pass it to a function, for example, so that it does not hold a reference to a temporary value.

Implementations

impl<'a> SliceBufViewMut<'a>

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

Trait Implementations

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

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

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

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

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

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

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

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 len(&self) -> usize

The length of 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 SliceBufViewMut<'a>

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.