Struct ReadBufMut

Source

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

Expand description

A type that grants mutable access to a ReadBuf.

You can create this by calling ReadBuf::as_mut.

Implementations§

Source §

impl<'a> ReadBufMut<'a>

Source

pub fn buf(&self) -> &ReadBuf<'a>

Get a shared reference to the internal buffer.

Source

pub unsafe fn buf_mut(&mut self) -> &mut ReadBuf<'a>

Get a mutable reference to the internal buffer.

§Safety

This must not be moved out of, and the buffer’s pointer to the bytes must not be changed.

Source

pub unsafe fn into_mut(self) -> &'a mut ReadBuf<'a>

Convert this type to a mutable reference to the internal buffer.

§Safety

This must not be moved out of, and the buffer’s pointer to the bytes must not be changed.

Source

pub fn as_mut(&mut self) -> ReadBufMut<'_>

Borrow the buffer, rather than consuming it.

Source §

impl ReadBufMut<'_>

These methods are also present on ReadBuf.

Source

pub fn capacity(&self) -> usize

Get the total capacity of the buffer.

Source

pub fn filled(&self) -> &[u8] ⓘ

Get a shared reference to the filled portion of the buffer.

Source

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

Get a mutable reference to the filled portion of the buffer.

Source

pub fn initialized(&self) -> &[u8] ⓘ

Get a shared reference to the initialized portion of the buffer.

This includes the filled portion.

Source

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

Get a mutable reference to the initialized portion of the buffer.

This includes the filled portion.

Source

pub unsafe fn unfilled_mut(&mut self) -> &mut [MaybeUninit<u8>]

Get a mutable reference to the unfilled part of the buffer without ensuring that it has been fully initialized.

§Safety

The caller must not deinitialize portions of the buffer that have already been initialized.

Source

pub fn all(&self) -> &[MaybeUninit<u8>]

Get a shared reference to the entire backing buffer.

Source

pub unsafe fn all_mut(&mut self) -> &mut [MaybeUninit<u8>]

Get a mutable reference to the entire backing buffer.

§Safety

The caller must not deinitialize portions of the buffer that have already been initialized.

Source

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

Get a mutable reference to the unfilled part of the buffer, ensuring it is fully

initialized.

Since ReadBuf tracks the region of the buffer that has been initialized, this is effectively “free” after the first use.

Source

pub fn initialize_unfilled_to(&mut self, n: usize) -> &mut [u8] ⓘ

Get a mutable reference to the first n bytes of the unfilled part of the buffer, ensuring it is fully initialized.

§Panics

Panics if self.remaining() is less than n.

Source

pub fn remaining(&self) -> usize

Get the number of bytes at the end of the slice that have not yet been filled.

Source

pub fn clear(&mut self)

Clear the buffer, resetting the filled region to empty.

The number of initialized bytes is not changed, and the contents of the buffer is not modified.

Source

pub fn add_filled(&mut self, n: usize)

Increase the size of the filled region of the buffer by n bytes.

The number of initialized bytes is not changed.

§Panics

Panics if the filled region of the buffer would become larger than the initialized region.

Source

pub fn set_filled(&mut self, n: usize)

Set the size of the filled region of the buffer to n.

The number of initialized bytes is not changed.

Note that this can be used to shrink the filled region of the buffer in addition to growing it (for example, by a Read implementation that compresses data in-place).

§Panics

Panics if the filled region of the buffer would become larger than the initialized region.

Source

pub unsafe fn assume_init(&mut self, n: usize)

Asserts that the first n unfilled bytes of the buffer are initialized.

ReadBuf assumes that bytes are never deinitialized, so this method does nothing when called with fewer bytes than are already known to be initialized.