Struct VectoredSlice 

pub struct VectoredSlice<T> { /* private fields */ }

Return type for IoVectoredBuf::slice and IoVectoredBufMut::slice_mut.

Behavior

When constructing the VectoredSlice, it will first compute how many buffers to skip. Imaging vectored buffers as concatenated slices, there will be uninitialized “slots” in between. This slice type provides two behaviors of how to skip through those slots, controlled by the marker type B:

• IoVectoredBuf::slice: Ignore uninitialized slots, i.e., skip begin-many initialized bytes.
• IoVectoredBufMut::slice_mut: Consider uninitialized slots, i.e., skip begin-many bytes.

This will only affect how the slice is being constructed. The resulting slice will always expose all of the remaining bytes, no matter initialized or not (in particular, IoVectoredBufMut::iter_uninit_slice).

Implementations

impl<T> VectoredSlice<T>

pub fn begin(&self) -> usize

Offset in the underlying buffer at which this slice starts.

pub fn as_inner(&self) -> &T

Gets a reference to the underlying buffer.

This method escapes the slice’s view.

pub fn as_inner_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying buffer.

This method escapes the slice’s view.

Trait Implementations

impl<T> IntoInner for VectoredSlice<T>

type Inner = T

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.

impl<T: IoVectoredBuf> IoVectoredBuf for VectoredSlice<T>

fn iter_slice(&self) -> impl Iterator<Item = &[u8]>

An iterator of initialized slice of the buffers.

fn total_len(&self) -> usize

The total length of all buffers.

fn owned_iter(self) -> Result<VectoredBufIter<Self>, Self>

where Self: Sized,

Wrap self into an owned iterator.

fn slice(self, begin: usize) -> VectoredSlice<Self>

where Self: Sized,

Get an owned view of the vectored buffer that skips the first begin-many initialized bytes.

impl<T: IoVectoredBufMut> IoVectoredBufMut for VectoredSlice<T>

fn iter_uninit_slice(&mut self) -> impl Iterator<Item = &mut [MaybeUninit<u8>]>

An iterator of maybe uninitialized slice of the buffers.

fn total_capacity(&mut self) -> usize

The total capacity of all buffers.

fn slice_mut(self, begin: usize) -> VectoredSlice<Self>

where Self: Sized,

Get an owned view of the vectored buffer.

impl<T: SetLen> SetLen for VectoredSlice<T>

unsafe fn set_len(&mut self, len: usize)

Set the buffer length.

unsafe fn advance_vec_to(&mut self, len: usize)

where Self: IoVectoredBuf,

Set the vector buffer’s total length to len. If len is less than the current total length, this operation is a no-op.