Trait IoBufMut

pub unsafe trait IoBufMut: Unpin + 'static {
    // Required methods
    fn write_ptr(&mut self) -> *mut u8;
    fn bytes_total(&mut self) -> usize;
    unsafe fn set_init(&mut self, pos: usize);

    // Provided methods
    fn slice_mut(self, range: impl RangeBounds<usize>) -> SliceMut<Self>
       where Self: Sized + IoBuf { ... }
    unsafe fn slice_mut_unchecked(
        self,
        range: impl RangeBounds<usize>,
    ) -> SliceMut<Self>
       where Self: Sized { ... }
}

A mutable io_uring compatible buffer.

The IoBufMut trait is implemented by buffer types that can be passed to io_uring operations. Users will not need to use this trait directly.

Safety

See the safety note of the methods.

Required Methods

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

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

monoio Runtime will Box::pin the buffer. Runtime makes sure the buffer will not be moved, and the implement must ensure as_ptr returns the same valid address. Kernel will write bytes_init-length data to the pointer.

fn bytes_total(&mut self) -> usize

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

This method is to be used by the monoio runtime and it is not expected for users to call it directly.

For Vec, this is identical to capacity().

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

Updates the number of initialized bytes.

The specified pos becomes the new value returned by IoBuf::bytes_init.

Safety

The caller must ensure that all bytes starting at stable_mut_ptr() up to pos are initialized and owned by the buffer.

Provided Methods

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

where Self: Sized + IoBuf,

Returns a view of the buffer with the specified range.

This method is similar to Rust’s slicing (&buf[..]), but takes ownership of the buffer.

Examples

use monoio::buf::{IoBuf, IoBufMut};

let buf = b"hello world".to_vec();
buf.slice(5..10);

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.

Safety

Begin must within the initialized bytes, end must be within the capacity.

Implementations on Foreign Types

impl IoBufMut for BytesMut

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

fn bytes_total(&mut self) -> usize

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

impl IoBufMut for Box<[u8]>

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

fn bytes_total(&mut self) -> usize

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

impl IoBufMut for Vec<u8>

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

fn bytes_total(&mut self) -> usize

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

impl<T> IoBufMut for ManuallyDrop<T>

where T: IoBufMut,

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

fn bytes_total(&mut self) -> usize

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

impl<const N: usize> IoBufMut for &'static mut [u8; N]

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

fn bytes_total(&mut self) -> usize

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

impl<const N: usize> IoBufMut for Box<[u8; N]>

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

fn bytes_total(&mut self) -> usize

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

Implementors

impl IoBufMut for RawBuf

impl<T: IoBufMut> IoBufMut for SliceMut<T>

impl<T: IoVecBufMut> IoBufMut for IoVecWrapperMut<T>