Struct RawBuf

pub struct RawBuf { /* private fields */ }

RawBuf is not a real buf. It only hold the pointer of the buffer. Users must make sure the buffer behind the pointer is always valid. Which means, user must:

1. await the future with RawBuf Ready before drop the real buffer
2. make sure the pointer and length is valid before the future Ready

Implementations

impl RawBuf

pub unsafe fn uninit() -> Self

Create a empty RawBuf.

Safety

do not use uninitialized RawBuf directly.

pub const unsafe fn new(ptr: *const u8, len: usize) -> Self

Create a new RawBuf with given pointer and length.

Safety

make sure the pointer and length is valid when RawBuf is used.

impl RawBuf

pub unsafe fn new_from_iovec_mut<T: IoVecBufMut>(data: &mut T) -> Option<Self>

Create a new RawBuf with the first iovec part.

Safety

make sure the pointer and length is valid when RawBuf is used.

pub unsafe fn new_from_iovec<T: IoVecBuf>(data: &T) -> Option<Self>

Create a new RawBuf with the first iovec part.

Safety

make sure the pointer and length is valid when RawBuf is used.

Trait Implementations

impl IoBuf for RawBuf

fn read_ptr(&self) -> *const u8

Returns a raw pointer to the vector’s buffer.

fn bytes_init(&self) -> usize

Number of initialized bytes.

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

Returns a slice of the buffer.

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

where Self: Sized,

Returns a view of the buffer with the specified range.

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

where Self: Sized,

Returns a view of the buffer with the specified range without boundary checking.

impl IoBufMut for RawBuf

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

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

fn bytes_total(&mut self) -> usize

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

unsafe fn set_init(&mut self, _pos: usize)

Updates the number of initialized bytes.

fn slice_mut(self, range: impl RangeBounds<usize>) -> SliceMut<Self>

where Self: Sized + IoBuf,

Returns a view of the buffer with the specified range.

unsafe fn slice_mut_unchecked( self, range: impl RangeBounds<usize>, ) -> SliceMut<Self>

where Self: Sized,

Returns a view of the buffer with the specified range.