Struct Uninit

pub struct Uninit<T>(/* private fields */);

A Slice that only exposes uninitialized bytes.

Uninit can be created with IoBuf::uninit.

Examples

Creating an uninit slice

use compio_buf::IoBuf;

let mut buf = Vec::from(b"hello world");
buf.reserve_exact(10);
let slice = buf.uninit();

assert_eq!(slice.as_slice(), b"");
assert_eq!(slice.buf_capacity(), 10);

Implementations

impl<T> Uninit<T>

pub fn begin(&self) -> usize

Offset in the underlying buffer at which uninitialized bytes 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: Clone> Clone for Uninit<T>

fn clone(&self) -> Uninit<T>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Uninit<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Uninit<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> IntoInner for Uninit<T>

type Inner = T

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.

impl<T: IoBuf> IoBuf for Uninit<T>

fn as_buf_ptr(&self) -> *const u8

Returns a raw pointer to the vector’s buffer.

fn buf_len(&self) -> usize

Number of initialized bytes.

fn buf_capacity(&self) -> usize

Total size of the buffer, including uninitialized memory, if any.

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

Get the initialized part of the buffer.

unsafe fn as_io_slice(&self) -> IoSlice

Create an IoSlice of this buffer.

fn slice(self, range: impl RangeBounds<usize>) -> Slice<Self>

where Self: Sized,

Returns a view of the buffer with the specified range.

fn uninit(self) -> Uninit<Self>

where Self: Sized,

Returns an Uninit, which is a Slice that only exposes uninitialized bytes.

fn filled(&self) -> bool

Indicate whether the buffer has been filled (uninit portion is empty)

impl<T: IoBufMut> IoBufMut for Uninit<T>

fn as_buf_mut_ptr(&mut self) -> *mut u8

Returns a raw mutable pointer to the vector’s buffer.

fn as_mut_slice(&mut self) -> &mut [MaybeUninit<u8>]

Get the uninitialized part of the buffer.

unsafe fn as_io_slice_mut(&mut self) -> IoSliceMut

Create an IoSliceMut of the uninitialized part of the buffer.

impl<T: Ord> Ord for Uninit<T>

fn cmp(&self, other: &Uninit<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Uninit<T>

fn eq(&self, other: &Uninit<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Uninit<T>

fn partial_cmp(&self, other: &Uninit<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: SetBufInit + IoBuf> SetBufInit for Uninit<T>

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

Set the buffer length. If len is less than the current length, nothing should happen.

impl<T: Copy> Copy for Uninit<T>

impl<T: Eq> Eq for Uninit<T>

impl<T> StructuralPartialEq for Uninit<T>