Struct IoBufferRef

pub struct IoBufferRef<'a> {
    pointer: *const u8,
    size: usize,
    _lifetime: PhantomData<&'a [u8]>,
}

Reference to any immutable memory buffer.

Fields

pointer: *const u8

Raw pointer to the start of the buffer.

size: usize

Size in bytes.

_lifetime: PhantomData<&'a [u8]>

Lifetime marker.

Implementations

impl<'a> IoBufferRef<'a>

pub fn from_slice(slice: &'a [u8]) -> Self

Create a reference to a slice.

pub fn try_into_owned(self, alignment: usize) -> Result<IoBuffer>

Create an owned IoBuffer with the same data (copied).

pub fn len(&self) -> usize

Size in bytes.

pub fn is_empty(&self) -> bool

Whether the length is 0.

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

Return the pointer to the start of the buffer.

pub fn into_slice(self) -> &'a [u8]

Turn this reference into a slice.

References to IoBuffers must not be copied/cloned (so they can only be accessed once; they are considered volatile due to potential VM guest accesses), so this consumes the object.

pub unsafe fn into_typed_slice<T: Copy + Sized>(self) -> &'a [T]

Turn this reference into a slice with the given element type.

Safety

Caller must ensure that alignment and length requirements are met and that the resulting data is valid.

pub fn split_at(self, mid: usize) -> (IoBufferRef<'a>, IoBufferRef<'a>)

Split the buffer at mid.

Return &self[..mid] and &self[mid..].

If mid > self.len(), return &self[..] and [].

pub fn into_ref(self) -> IoBufferRef<'a>

Make this reference immutable.

Trait Implementations

impl<'a> From<IoBufferRef<'a>> for IoSlice<'a>

fn from(buf: IoBufferRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<IoBufferRef<'a>> for IoVector<'a>

fn from(buffer: IoBufferRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<IoSlice<'a>> for IoBufferRef<'a>

fn from(slice: IoSlice<'a>) -> Self

Converts to this type from the input type.

impl<'a> IoBufferRefTrait<'a> for IoBufferRef<'a>

type SliceType<T: Copy + Sized + 'a> = &'a [T]

&[T] or &mut [T].

type PointerType<T: Copy + Sized + 'a> = *const T

*const T or *mut T.

fn from_slice(slice: Self::SliceType<u8>) -> Self

Create a reference to a slice.

fn try_into_owned(self, alignment: usize) -> Result<IoBuffer>

Create an owned IoBuffer with the same data (copied).

fn len(&self) -> usize

Size in bytes.

fn as_ptr(&self) -> Self::PointerType<u8>

Return the pointer to the start of the buffer.

fn split_at(self, mid: usize) -> (Self, Self)

Split the buffer at mid.

fn into_ref(self) -> IoBufferRef<'a>

Make this reference immutable.

unsafe fn into_typed_slice<T: Copy + Sized>(self) -> Self::SliceType<T>

Turn this reference into a slice with the given element type.

fn is_empty(&self) -> bool

Whether the length is 0.

fn into_slice(self) -> Self::SliceType<u8>

Turn this reference into a slice.

impl Send for IoBufferRef<'_>

impl Sync for IoBufferRef<'_>