Struct CBox 

pub struct CBox<T, TAllocator: Allocator> { /* private fields */ }

The ABI-stable box type. This type is equivalent to the standard Box type, except it is suitable for FFI and also accepts any allocator.

Implementations

impl<T, TAllocator: Allocator> CBox<T, TAllocator>

pub fn new(value: T) -> Result<Self, CBoxError>

where TAllocator: Default,

Creates a new CBox with the default allocator.

Errors

For details see CBoxError.

pub fn with_allocator( value: T, allocator: TAllocator, ) -> Result<Self, CBoxError>

Creates a new CBox with a custom allocator.

Errors

For details see CBoxError.

pub const fn data(box_: &Self) -> &T

Returns a reference to the data stored in the CBox.

pub const fn data_mut(box_: &mut Self) -> &mut T

Returns a mutable reference to the data stored in the CBox.

pub const fn data_ptr(box_: &Self) -> *const T

Returns a raw pointer to the underlying data stored in the CBox.

The caller must ensure that the pointer does not outlive the CBox.

pub const fn into_raw_ptr(box_: Self) -> *mut u8

Converts the CBox into a raw pointer.

Notes

• This method does not touch internal structure of the CBox, self is simply forgotten.
• The caller must ensure that the pointer does not outlive the CBox.

pub const unsafe fn from_raw_ptr(ptr: *mut u8) -> Self

Converts a raw pointer back to a CBox container.

Safety

• The caller must ensure that the pointer came from the previous call to CBox::into_raw_ptr.
• The caller must ensure that the raw pointer won’t be used after the call.

Otherwise the behavior is undefined.

pub const fn data_ptr_mut(box_: &mut Self) -> *mut T

Returns a raw mutable pointer to the underlying data stored in the CBox.

The caller must ensure that the pointer does not outlive the CBox.

pub fn unpack(box_: Self) -> T

Unpacks the CBox and returns the data. The underlying memory gets deallocated.

Trait Implementations

impl<T, TAllocator: Allocator> AsMut<T> for CBox<T, TAllocator>

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

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

impl<T, TAllocator: Allocator> AsRef<T> for CBox<T, TAllocator>

fn as_ref(&self) -> &T

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

impl<T, TAllocator: Allocator> Borrow<T> for CBox<T, TAllocator>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, TAllocator: Allocator> BorrowMut<T> for CBox<T, TAllocator>

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

Mutably borrows from an owned value.

impl<T, TAllocator> Clone for CBox<T, TAllocator>

where T: TryClone, TAllocator: Allocator + TryClone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, TAllocator: Debug + Allocator> Debug for CBox<T, TAllocator>

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

Formats the value using the given formatter.

impl<T, TAllocator: Allocator> Deref for CBox<T, TAllocator>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, TAllocator: Allocator> DerefMut for CBox<T, TAllocator>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T, TAllocator: Allocator + Default> Deserialize<'de> for CBox<T, TAllocator>

where T: Deserialize<'de>,

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, TAllocator: Allocator> Drop for CBox<T, TAllocator>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: ReprC, TAllocator: Allocator> ReprC for CBox<T, TAllocator>

const CHECK: ()

This field is used for const checks only.

impl<T, TAllocator: Allocator> Serialize for CBox<T, TAllocator>

where T: Serialize,

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, TAllocator> TryClone for CBox<T, TAllocator>

where T: TryClone, TAllocator: Allocator + TryClone,

type Error = CBoxTryCloneError

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.