Struct IoVectorMut

pub struct IoVectorMut<'a> {
    vector: Vec<IoSliceMut<'a>>,
    total_size: u64,
}

Vector of memory buffers.

Fields

vector: Vec<IoSliceMut<'a>>

Buffer list.

total_size: u64

Complete size in bytes.

Implementations

impl<'a> IoVectorMut<'a>

pub fn new() -> Self

Create an empty vector.

pub fn with_capacity(cap: usize) -> Self

Create an empty vector, pre-allocating space for cap buffers.

This does not allocate an memory buffer, only space in the buffer vector.

pub fn push(&mut self, slice: &'a mut [u8])

Append a slice.

pub fn push_ioslice(&mut self, ioslice: IoSliceMut<'a>)

Append a slice.

pub fn insert(&mut self, index: usize, slice: &'a mut [u8])

Insert a slice at the given index in the buffer vector.

pub fn len(&self) -> u64

Return the sum total length in bytes of all buffers in this vector.

pub fn buffer_count(&self) -> usize

Return the number of buffers in this vector.

pub fn is_empty(&self) -> bool

Return true if and only if this vector’s length is zero.

Synonymous with whether this vector’s buffer count is zero.

pub fn append(&mut self, other: Self)

Append all buffers from the given other vector to this vector.

pub fn split_at(self, mid: u64) -> (Self, Self)

Split the vector into two.

The first returned vector contains the bytes in the [..mid] range, and the second one covers the [mid..] range.

pub fn split_tail_at(self, mid: u64) -> Self

Like Self::split_at(), but discards the head, only returning the tail.

More efficient than to use self.split_at(mid).1 because the former requires creating a new Vec object for the head, which this version skips.

pub fn copy_into_slice(&self, slice: &mut [u8])

Copy the data from self into slice.

Both must have the same length.

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

Create a single owned IoBuffer with the same data (copied).

pub unsafe fn as_iovec<'b>(&'b self) -> &'b [iovec]

where Self: 'b,

Return a corresponding &[libc::iovec].

Safety

iovec has no lifetime information. Callers must ensure no elements in the returned slice are used beyond the lifetime '_.

pub fn is_aligned(&self, mem_alignment: usize, req_alignment: usize) -> bool

Check whether self is aligned.

Each buffer must be aligned to mem_alignment, and each buffer’s length must be aligned to both mem_alignment and req_alignment (the I/O request offset/size alignment).

pub fn into_inner(self) -> Vec<IoSliceMut<'a>>

Return the internal vector of IoSlice objects.

pub fn with_pushed<'b>(self, slice: &'b mut [u8]) -> IoVectorMut<'b>

where 'a: 'b,

Same as Self::push(), but takes ownership of self.

By taking ownership of self and returning it, this method allows reducing the lifetime of self to that of slice, if necessary.

pub fn with_inserted<'b>( self, index: usize, slice: &'b mut [u8], ) -> IoVectorMut<'b>

where 'a: 'b,

Same as Self::insert(), but takes ownership of self.

By taking ownership of self and returning it, this method allows reducing the lifetime of self to that of slice, if necessary.

fn do_split_at( self, mid: u64, keep_head: bool, ) -> (Option<IoVectorMut<'a>>, IoVectorMut<'a>)

Implementation for Self::split_at() and Self::split_tail_at().

If keep_head is true, both head and tail are returned (Self::split_at()). Otherwise, the head is discarded (Self::split_tail_at()).

impl IoVectorMut<'_>

pub fn fill(&mut self, value: u8)

Fill all buffers in the vector with the given byte pattern.

pub fn copy_from_slice(&mut self, slice: &[u8])

Copy data from slice into the buffers in this vector.

The vector and the slice must have the same total length.

impl<'a> IoVectorMut<'a>

pub fn from_volatile_slice<B: BitmapSlice, I: IntoIterator<Item: ImagoAsRef<'a, VolatileSlice<'a, B>>, IntoIter: ExactSizeIterator>>( slices: I, ) -> (Self, VolatileSliceGuard<'a, PtrGuardMut, B>)

Converts a VolatileSlice array (from vm-memory) into an IoVectorMut.

In addition to a the vector, return a guard that ensures that the memory in slices is indeed mapped while in use. This guard must not be dropped while this vector is in use!

Trait Implementations

impl Debug for IoVectorMut<'_>

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

Formats the value using the given formatter.

impl<'a> Default for IoVectorMut<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a mut [u8]> for IoVectorMut<'a>

fn from(slice: &'a mut [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut IoBuffer> for IoVectorMut<'a>

fn from(buf: &'a mut IoBuffer) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut Vec<u8>> for IoVectorMut<'a>

fn from(vec: &'a mut Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> From<IoBufferMut<'a>> for IoVectorMut<'a>

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

Converts to this type from the input type.

impl<'a> From<Vec<IoSliceMut<'a>>> for IoVectorMut<'a>

fn from(vector: Vec<IoSliceMut<'a>>) -> Self

Converts to this type from the input type.

impl<'a> IoVectorTrait for IoVectorMut<'a>

type SliceType = &'a mut [u8]

&[u8] or &mut [u8].

type BufferType = IoSliceMut<'a>

IoSlice or IoSliceMut.

fn new() -> Self

Create an empty vector.

fn with_capacity(cap: usize) -> Self

Create an empty vector, pre-allocating space for cap buffers.

fn push(&mut self, slice: Self::SliceType)

Append a slice.

fn push_ioslice(&mut self, ioslice: Self::BufferType)

Append a slice.

fn insert(&mut self, index: usize, slice: Self::SliceType)

Insert a slice at the given index in the buffer vector.

fn len(&self) -> u64

Return the sum total length in bytes of all buffers in this vector.

fn buffer_count(&self) -> usize

Return the number of buffers in this vector.

fn append(&mut self, other: Self)

Append all buffers from the given other vector to this vector.

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

Split the vector into two.

fn split_tail_at(self, mid: u64) -> Self

Like IoVectorTrait::split_at(), but discards the head, only returning the tail.

fn copy_into_slice(&self, slice: &mut [u8])

Copy the data from self into slice.

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

Create a single owned IoBuffer with the same data (copied).

fn is_aligned(&self, mem_alignment: usize, req_alignment: usize) -> bool

Check whether self is aligned.

fn into_inner(self) -> Vec<Self::BufferType>

Return the internal vector of IoSlice objects.

unsafe fn as_iovec<'b>(&'b self) -> &'b [iovec]

where Self: 'b,

Return a corresponding &[libc::iovec].

fn is_empty(&self) -> bool

Return true if and only if this vector’s length is zero.