Struct `ReadBuf`

struct ReadBuf<'a> { ... }

A wrapper around a byte buffer that is incrementally filled and initialized.

This type is a sort of "double cursor". It tracks three regions in the buffer: a region at the beginning of the buffer that has been logically filled with data, a region that has been initialized at some point but not yet logically filled, and a region at the end that may be uninitialized. The filled region is guaranteed to be a subset of the initialized region.

In summary, the contents of the buffer can be visualized as:

[             capacity              ]
[ filled |         unfilled         ]
[    initialized    | uninitialized ]

It is undefined behavior to de-initialize any bytes from the uninitialized region, since it is merely unknown whether this region is uninitialized or not, and if part of it turns out to be initialized, it must stay initialized.

Implementations

`impl<'a> ReadBuf<'a>`

fn new(buf: &'a mut [u8]) -> ReadBuf<'a>

Creates a new ReadBuf from a fully initialized buffer.

fn uninit(buf: &'a mut [MaybeUninit<u8>]) -> ReadBuf<'a>

Creates a new ReadBuf from a buffer that may be uninitialized.

The internal cursor will mark the entire buffer as uninitialized. If the buffer is known to be partially initialized, then use assume_init to move the internal cursor.

fn capacity(self: &Self) -> usize

Returns the total capacity of the buffer.

fn filled(self: &Self) -> &[u8]

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

fn filled_mut(self: &mut Self) -> &mut [u8]

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

fn take(self: &mut Self, n: usize) -> ReadBuf<'_>

Returns a new ReadBuf comprised of the unfilled section up to n.

fn initialized(self: &Self) -> &[u8]

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

This includes the filled portion.

fn initialized_mut(self: &mut Self) -> &mut [u8]

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

This includes the filled portion.

unsafe fn inner_mut(self: &mut Self) -> &mut [MaybeUninit<u8>]

Returns a mutable reference to the entire buffer, without ensuring that it has been fully initialized.

The elements between 0 and self.filled().len() are filled, and those between 0 and self.initialized().len() are initialized (and so can be converted to a &mut [u8]).

The caller of this method must ensure that these invariants are upheld. For example, if the caller initializes some of the uninitialized section of the buffer, it must call assume_init with the number of bytes initialized.

Safety

The caller must not de-initialize portions of the buffer that have already been initialized. This includes any bytes in the region marked as uninitialized by ReadBuf.

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

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

Safety

The caller must not de-initialize portions of the buffer that have already been initialized. This includes any bytes in the region marked as uninitialized by ReadBuf.

fn initialize_unfilled(self: &mut Self) -> &mut [u8]

Returns 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.

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

Returns 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.

fn remaining(self: &Self) -> usize

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

fn clear(self: &mut Self)

Clears the buffer, resetting the filled region to empty.

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

fn advance(self: &mut Self, n: usize)

Advances the size of the filled region of the buffer.

The number of initialized bytes is not changed.

Panics

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

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

Sets the size of the filled region of the buffer.

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 AsyncRead implementation that compresses data in-place).

Panics

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

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

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

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

Safety

The caller must ensure that n unfilled bytes of the buffer have already been initialized.

fn put_slice(self: &mut Self, buf: &[u8])

Appends data to the buffer, advancing the written position and possibly also the initialized position.

Panics

Panics if self.remaining() is less than buf.len().

`impl Debug for ReadBuf<'_>`

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

`impl<'a> BufMut for ReadBuf<'a>`

fn remaining_mut(self: &Self) -> usize
unsafe fn advance_mut(self: &mut Self, cnt: usize)
fn chunk_mut(self: &mut Self) -> &mut UninitSlice

`impl<'a> Freeze for ReadBuf<'a>`

`impl<'a> RefUnwindSafe for ReadBuf<'a>`

`impl<'a> Send for ReadBuf<'a>`

`impl<'a> Sync for ReadBuf<'a>`

`impl<'a> Unpin for ReadBuf<'a>`

`impl<'a> UnsafeUnpin for ReadBuf<'a>`

`impl<'a> UnwindSafe for ReadBuf<'a>`

`impl<T> Any for ReadBuf<'a>`

fn type_id(self: &Self) -> TypeId

`impl<T> Borrow for ReadBuf<'a>`

fn borrow(self: &Self) -> &T

`impl<T> BorrowMut for ReadBuf<'a>`

fn borrow_mut(self: &mut Self) -> &mut T

`impl<T> From for ReadBuf<'a>`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T, U> Into for ReadBuf<'a>`

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

`impl<T, U> TryFrom for ReadBuf<'a>`

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

`impl<T, U> TryInto for ReadBuf<'a>`

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>