Struct mbox::mbox::MBox

pub struct MBox<T: ?Sized + Free>(_);

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

Methods

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

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

Constructs a new malloc-backed box from a pointer allocated by malloc. The content of the pointer must be already initialized.

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

Obtains the pointer owned by the box.

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

Obtains the mutable pointer owned by the box.

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

pub fn into_raw(self) -> *mut T

Consumes the box and returns the original pointer.

The caller is responsible for freeing the pointer after this.

impl<T> MBox<T>

pub fn new(value: T) -> MBox<T>

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

impl<T> MBox<[T]>

pub unsafe fn from_raw_parts(value: *mut T, len: usize) -> MBox<[T]>

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

The malloced size of the pointer must be at least len * size_of::<T>(). The content must already been 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).

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).

The malloced size of the pointer must be at least len. If the content does not contain valid UTF-8, this method returns an Err.

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. The 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.

pub fn from_str(string: &str) -> MBox<str>

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

Dereferences the value.

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Mutably dereferences the value.

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn as_ref(&self) -> &T

Performs the conversion.

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Performs the conversion.

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Mutably borrows from an owned value.

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

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 + Debug> Debug for MBox<T>

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

Formats the value using the given formatter.

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 + 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, 

Feeds a slice of this type into the given [Hasher].

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 !=.

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

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 + 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Performs the conversion.

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<T: Default> Default for MBox<T>

fn default() -> MBox<T>

Returns the "default value" for a type.

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

fn default() -> Self

Returns the "default value" for a type.

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> FromIterator<T> for MBox<[T]>

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

Creates a value from an iterator.

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?

Important traits for MSliceIntoIter<T>

impl<T> Iterator for MSliceIntoIter<T> type Item = T;

fn into_iter(self) -> MSliceIntoIter<T>

Creates an iterator from a value.

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?

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

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?

Important traits for IterMut<'a, T>

impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;

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

Creates an iterator from a value.

impl Default for MBox<str>

fn default() -> Self

Returns the "default value" for a type.

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.