Struct data_model::iobuf::IoBufMut

#[repr(transparent)]
pub struct IoBufMut<'a> {
    iobuf: IoBuf,
    phantom: PhantomData<&'a mut [u8]>,
}

Cross-platform mutable buffer.

This type is essentialy std::io::IoSliceMut, and guaranteed to be ABI-compatible with libc::iovec on Linux/WSABUF on Windows; however, it does NOT automatically deref to &mut [u8], which is critical because it can point to guest memory. (Guest memory is implicitly mutably borrowed by the guest, so another mutable borrow would violate Rust assumptions about references.)

Fields

iobuf: IoBuf

phantom: PhantomData<&'a mut [u8]>

Implementations

impl<'a> IoBufMut<'a>

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

pub unsafe fn from_raw_parts(addr: *mut u8, len: usize) -> IoBufMut<'a>

Creates a IoBufMut from a pointer and a length.

Safety

In order to use this method safely, addr must be valid for reads and writes of len bytes and should live for the entire duration of lifetime 'a.

pub unsafe fn from_iobuf(iobuf: IoBuf) -> IoBufMut<'a>

Creates a IoBufMut from an IoBuf.

Safety

In order to use this method safely, iobuf must be valid for reads and writes through its length and should live for the entire duration of lifetime 'a.

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

Advance the internal position of the buffer.

Panics if count > self.len().

pub fn truncate(&mut self, len: usize)

Shorten the length of the buffer.

Has no effect if len > self.len().

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_ptr(&self) -> *const u8

Gets a const pointer to this slice’s memory.

pub fn as_mut_ptr(&self) -> *mut u8

Gets a mutable pointer to this slice’s memory.

pub fn as_iobufs<'slice>(iovs: &'slice [IoBufMut<'_>]) -> &'slice [IoBuf]

Converts a slice of IoBufMuts into a slice of IoBufs.

Trait Implementations

impl<'a> AsMut<iovec> for IoBufMut<'a>

fn as_mut(&mut self) -> &mut IoBuf

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a> AsRef<iovec> for IoBufMut<'a>

fn as_ref(&self) -> &IoBuf

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for IoBufMut<'a>

fn clone(&self) -> IoBufMut<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IoBufMut<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for IoBufMut<'a>

impl<'a> Send for IoBufMut<'a>

impl<'a> Sync for IoBufMut<'a>