Struct ReadBuf 

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

A buffer being filled by reads: its first filled bytes hold data, its first initialized bytes are initialized (filled <= initialized), and the rest may be uninitialized memory that a read may write into.

Implementations

impl<'a> ReadBuf<'a>

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

A buffer over buf, all of it initialized, none of it filled.

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

A buffer over buf, none of it initialized or filled.

pub fn capacity(&self) -> usize

The buffer’s whole length.

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

The bytes filled so far.

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

The bytes filled so far, to change.

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

The bytes known to be initialized, filled or not.

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

The bytes known to be initialized, to change.

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

A buffer over at most n bytes of the unfilled part, sharing what is known to be initialized there.

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

Initializes the whole unfilled part (zeroing what was not initialized) and answers it, for a read to write into.

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

Initializes the first n bytes of the unfilled part and answers them.

Panics

When n is more than remaining.

pub fn remaining(&self) -> usize

The room left after the filled part.

pub fn clear(&mut self)

Empties the filled part; what was initialized stays initialized.

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

Counts n more bytes as filled.

Panics

When that passes the initialized part.

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

Sets how many bytes are filled.

Panics

When n passes the initialized part.

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

Counts the first n bytes of the unfilled part as initialized.

Safety

The caller has initialized those bytes.

pub fn put_slice(&mut self, bytes: &[u8])

Appends bytes to the filled part.

Panics

When they do not fit in remaining.

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

The unfilled part, as memory that may be uninitialized.

Safety

The caller must not write uninitialized bytes into it: the part known to be initialized must stay initialized.

Trait Implementations

impl Debug for ReadBuf<'_>

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

Formats the value using the given formatter.