Struct mbox::mbox::MBox

pub struct MBox<T: ?Sized + Free>(/* private fields */);

A malloc-backed box. This structure allows Rust to exchange objects with C without cloning.

Implementations

impl<T: ?Sized + Free> MBox<T>

pub unsafe fn from_raw(ptr: *mut T) -> Self

Constructs a new malloc-backed box from a pointer allocated by malloc.

Safety

The ptr must be allocated via malloc(), calloc() or similar C functions that is expected to be deallocated using free(). It must be aligned and not null. The content of the pointer must be already initialized. The pointer’s ownership is passed into the box, and thus should not be used after this function returns.

Note that even when T is zero-sized, the input ptr is still expected to be released using free(). Therefore, you must not use a conceived dangling pointer such as NonNull::dangling() here. Consider using malloc(1) in case of ZSTs.

pub unsafe fn from_non_null_raw(ptr: NonNull<T>) -> Self

Constructs a new malloc-backed box from a non-null pointer allocated by malloc.

Safety

The ptr must be allocated via malloc(), calloc() or similar C functions that is expected to be deallocated using free(). The content of the pointer must be already initialized. The pointer’s ownership is passed into the box, and thus should not be used after this function returns.

Note that even when T is zero-sized, the input ptr is still expected to be released using free(). Therefore, you must not use a conceived dangling pointer such as NonNull::dangling() here. Consider using malloc(1) in case of ZSTs.

pub fn as_ptr(boxed: &Self) -> *const T

Obtains the pointer owned by the box.

pub fn as_mut_ptr(boxed: &mut Self) -> *mut T

Obtains the mutable pointer owned by the box.

pub fn into_raw(boxed: Self) -> *mut T

Consumes the box and returns the original pointer.

The caller is responsible for freeing the pointer after this.

pub fn into_non_null_raw(boxed: Self) -> NonNull<T>

Consumes the box and returns the original non-null pointer.

The caller is responsible for freeing the pointer after this.

impl<T> MBox<T>

pub fn new(value: T) -> Self

Constructs a new malloc-backed box, and move an initialized value into it.

pub fn new_uninit() -> MBox<MaybeUninit<T>>

Constructs a new malloc-backed box with uninitialized content.

pub fn pin(value: T) -> Pin<Self>

Constructs a new Pin<MBox<T>>. If T does not implement Unpin, then value will be pinned in memory and cannot be moved.

pub fn into_boxed_slice(boxed: Self) -> MBox<[T]>

Converts an MBox<T> into a single-item MBox<[T]>.

This conversion does not allocate on the heap and happens in place.

pub fn into_inner(boxed: Self) -> T

Consumes the MBox, returning the wrapped value.

pub fn into_pin(boxed: Self) -> Pin<Self>

Converts an MBox<T> into a Pin<MBox<T>>.

This conversion does not allocate on the heap and happens in place.

pub fn leak<'a>(boxed: Self) -> &'a mut T

where T: 'a,

Consumes and leaks the MBox, returning a mutable reference, &'a mut T.

impl<T> MBox<MaybeUninit<T>>

pub unsafe fn assume_init(self) -> MBox<T>

Converts into an initialized box.

Safety

The caller should guarantee *self is indeed initialized.

impl<T> MBox<[T]>

pub unsafe fn from_raw_parts(ptr: *mut T, len: usize) -> Self

Constructs a new malloc-backed slice from the pointer and the length (number of items).

Safety

ptr must be allocated via malloc() or similar C functions. It must be aligned and not null.

The malloced size of the pointer must be at least len * size_of::<T>(). The content must already been initialized.

pub fn new_uninit_slice(len: usize) -> MBox<[MaybeUninit<T>]>

Constructs a new boxed slice with uninitialized contents.

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

Decomposes the boxed slice into a pointer to the first element and the slice length.

impl<T> MBox<[MaybeUninit<T>]>

pub unsafe fn assume_init(self) -> MBox<[T]>

Converts into an initialized boxed slice.

Safety

The caller should guarantee *self is indeed initialized.

impl<T: Clone> MBox<[T]>

pub fn from_slice(slice: &[T]) -> MBox<[T]>

Creates a new malloc-boxed slice by cloning the content of an existing slice.

impl MBox<str>

pub unsafe fn from_raw_utf8_parts_unchecked( value: *mut u8, len: usize ) -> MBox<str>

Constructs a new malloc-backed string from the pointer and the length (number of UTF-8 code units).

Safety

The malloced size of the pointer must be at least len. The content must already been initialized and be valid UTF-8.

pub unsafe fn from_raw_utf8_parts( value: *mut u8, len: usize ) -> Result<MBox<str>, Utf8Error>

Constructs a new malloc-backed string from the pointer and the length (number of UTF-8 code units). If the content does not contain valid UTF-8, this method returns an Err.

Safety

The malloced size of the pointer must be at least len. The content must already been initialized.

pub fn into_bytes(self) -> MBox<[u8]>

Converts the string into raw bytes.

pub unsafe fn from_utf8_unchecked(bytes: MBox<[u8]>) -> MBox<str>

Creates a string from raw bytes.

Safety

The raw bytes must be valid UTF-8.

pub fn from_utf8(bytes: MBox<[u8]>) -> Result<MBox<str>, Utf8Error>

Creates a string from raw bytes. If the content does not contain valid UTF-8, this method returns an Err.

Trait Implementations

impl<T: ?Sized + Free> AsMut<T> for MBox<T>

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

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

impl<T: ?Sized + Free> AsRef<T> for MBox<T>

fn as_ref(&self) -> &T

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

impl<T: ?Sized + Free> Borrow<T> for MBox<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized + Free> BorrowMut<T> for MBox<T>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: Clone> Clone for MBox<[T]>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone> Clone for MBox<T>

fn clone(&self) -> MBox<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Clone for MBox<str>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized + Free + Debug> Debug for MBox<T>

fn fmt(&self, formatter: &mut Formatter<'_>) -> FormatResult

Formats the value using the given formatter.

impl<T> Default for MBox<[T]>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Default> Default for MBox<T>

fn default() -> MBox<T>

Returns the “default value” for a type.

impl Default for MBox<str>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized + Free> Deref for MBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized + Free> DerefMut for MBox<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: ?Sized + Free + Display> Display for MBox<T>

fn fmt(&self, formatter: &mut Formatter<'_>) -> FormatResult

Formats the value using the given formatter.

impl<T: ?Sized + Free> Drop for MBox<T>

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for MBox<str>

fn from(string: &str) -> Self

Creates a new malloc-boxed string by cloning the content of an existing string slice.

impl<T> From<T> for MBox<T>

fn from(value: T) -> MBox<T>

Converts to this type from the input type.

impl<T> FromIterator<T> for MBox<[T]>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: ?Sized + Free + Hash> Hash for MBox<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> IntoIterator for &'a MBox<[T]>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut MBox<[T]>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T> IntoIterator for MBox<[T]>

type Item = T

The type of the elements being iterated over.

type IntoIter = MSliceIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> MSliceIntoIter<T>

Creates an iterator from a value.

impl<T: ?Sized + Free + Ord> Ord for MBox<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<U: ?Sized + Free, T: ?Sized + Free + PartialEq<U>> PartialEq<MBox<U>> for MBox<T>

fn eq(&self, other: &MBox<U>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<U: ?Sized + Free, T: ?Sized + Free + PartialOrd<U>> PartialOrd<MBox<U>> for MBox<T>

fn partial_cmp(&self, other: &MBox<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized + Free> Pointer for MBox<T>

fn fmt(&self, formatter: &mut Formatter<'_>) -> FormatResult

Formats the value using the given formatter.

impl<T: ?Sized + Free + Eq> Eq for MBox<T>

impl<T: ?Sized + Free> StableDeref for MBox<T>

impl<T: ?Sized + Free> Unpin for MBox<T>