Struct ioslice::IoBox

#[repr(transparent)]pub struct IoBox<I: Initialization = Initialized> { /* fields omitted */ }

An owned chunk of memory, that is ABI-compatible with libc::iovec. At the moment this does not work on Windows.

This must be allocated via the system alloc; importing pointers from malloc(2) is currently not possible.

Implementations

impl<I: Initialization> IoBox<I>

pub fn try_alloc_zeroed(length: usize) -> Result<Self, AllocationError>

Attempt to allocate length bytes, which are initially set to zero.

This allocation may fail, but should not be used unless the global allocator actually does return null when there is no memory. This is generally not the case for userspace processes, where the kernel gives more memory than physically available, but is obviously useful in #![no_std].

Since the allocator may be able to already have zeroed blocks of memory, this should be preferred over manually initializing it using zeroed.

pub fn alloc_zeroed(length: usize) -> Self

Allocate length bytes, which are initially set to zero.

Panics

This method will, like most other heap-allocated structures in the alloc crate, panic when there is no available memory left.

pub fn into_raw_parts(self) -> (*mut u8, usize)

Turn the I/O box into the underlying pointer and size.

pub unsafe fn from_raw_parts(base: *mut u8, len: usize) -> Self

Convert an underlying pointer and size, into an IoBox.

Safety

For this to be safe, the validity and initialization invariants must be held. In addition to that, the pointer must be allocated using the system allocator.

pub fn into_iovec(self) -> iovec

pub fn into_box(self) -> Box<[u8]>

pub fn as_ioslice(&self) -> IoSlice<'_, I>

pub fn as_ioslice_mut(&mut self) -> IoSliceMut<'_, I>

pub fn inner_data(&self) -> &[I::DerefTargetItem]

pub fn inner_data_mut(&mut self) -> &mut [I::DerefTargetItem]

pub fn slice_as_ioslices(these: &[Self]) -> &[IoSlice<'_>]

pub fn slice_as_ioslices_mut(these: &mut [Self]) -> &mut [IoSlice<'_>]

pub fn slice_as_mut_ioslices(these: &[Self]) -> &[IoSliceMut<'_>]

pub fn slice_as_mut_ioslices_mut(these: &mut [Self]) -> &mut [IoSliceMut<'_>]

pub unsafe fn assume_init(self) -> IoBox<Initialized>

Convert IoBox<_> into IoBox<Initialized>, assuming that the data is initialized.

Safety

This shall not be used for initializing data. In that case, initialize it manually via as_maybe_uninit_slice_mut, and then call this.

While the validity invariant is already upheld when creating this type, the caller must ensure that the data be initialized. Refer to the std::mem::MaybeUninit docs.

pub fn as_maybe_uninit_slice(&self) -> &[MaybeUninit<u8>]

pub fn as_maybe_uninit_slice_mut(&mut self) -> &mut [MaybeUninit<u8>]

pub fn zeroed(self) -> IoBox<Initialized>

pub fn try_alloc_uninit(
    length: usize
) -> Result<IoBox<Uninitialized>, AllocationError>

pub fn alloc_uninit(length: usize) -> IoBox<Uninitialized>

impl IoBox<Initialized>

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

pub fn as_slice_mut(&mut self) -> &mut [u8]

Trait Implementations

impl AsMut<[u8]> for IoBox

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for IoBox

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

Performs the conversion.

impl Borrow<[u8]> for IoBox

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

Immutably borrows from an owned value.

impl BorrowMut<[u8]> for IoBox

fn borrow_mut(&mut self) -> &mut [u8]

Mutably borrows from an owned value.

impl Debug for IoBox

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

Formats the value using the given formatter.

impl Deref for IoBox

type Target = [u8]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for IoBox

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl<I: Initialization> Drop for IoBox<I>

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for IoBox

impl From<Box<[u8]>> for IoBox

fn from(boxed: Box<[u8]>) -> Self

Performs the conversion.

impl From<IoBox<Initialized>> for Box<[u8]>

fn from(io_box: IoBox) -> Self

Performs the conversion.

impl From<IoBox<Initialized>> for Vec<u8>

fn from(io_box: IoBox) -> Self

Performs the conversion.

impl From<Vec<u8>> for IoBox

fn from(vector: Vec<u8>) -> Self

Performs the conversion.

impl PartialEq<[u8]> for IoBox

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<IoBox<Initialized>> for IoBox

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<IoSlice<'a, Initialized>> for IoBox

fn eq(&self, other: &IoSlice<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<IoSliceMut<'a, Initialized>> for IoBox

fn eq(&self, other: &IoSliceMut<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.