Struct gharial::TestBox

pub struct TestBox<'a, T, A = TestAlloc> where
    A: GlobalAlloc,  { /* fields omitted */ }

TestBox behaves like std::boxed::Box except for it owns a reference to a GlobalAlloc .

The default type of the GlobalAlloc reference is &TestAlloc . Unlike to std::boxed::Box , it cause an assertion error when the GlobalAlloc is dropped unless TestBox is surely dropped.

For example, it sometimes requires to allocate heap memory to implement container struct, and then the elements must be dropped manually. TestBox helps the test to make sure the elements are dropped.

Implementations

impl<'a, T, A> TestBox<'a, T, A> where
    A: GlobalAlloc, 

pub fn new(x: T, alloc: &'a A) -> Self

Creates a new instance.

pub unsafe fn from_raw_alloc(ptr: *mut T, alloc: &'a A) -> Self

Creates a new instance from raw pointer and a reference to allocator.

After calling this function, the raw pointer is owned by the resulting TestBox . Specifically, TestBox::drop destructs the referenced object and free the pointer.

Safety

To use this function safe, the ptr should be allocated via alloc and it should not be freed anywhere else.

impl<'a, T, A> TestBox<'a, T, A> where
    A: GlobalAlloc, 

pub fn leak(tb: Self) -> &'a mut T where
    T: 'a, 

Consumes and leaks TestBox .

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

Consumes the TestBox and returning a wrapped raw pointer.

Trait Implementations

impl<T, A, '_> AsMut<T> for TestBox<'_, T, A> where
    A: GlobalAlloc, 

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

Performs the conversion.

impl<T, A, '_> AsRef<T> for TestBox<'_, T, A> where
    A: GlobalAlloc, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<T, A, '_> Borrow<T> for TestBox<'_, T, A> where
    A: GlobalAlloc, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, A, '_> BorrowMut<T> for TestBox<'_, T, A> where
    A: GlobalAlloc, 

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

Mutably borrows from an owned value.

impl<T, A, '_> Clone for TestBox<'_, T, A> where
    T: Clone,
    A: GlobalAlloc, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, A, '_> Deref for TestBox<'_, T, A> where
    A: GlobalAlloc, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, A, '_> DerefMut for TestBox<'_, T, A> where
    A: GlobalAlloc, 

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

Mutably dereferences the value.

impl<T, A, '_> Drop for TestBox<'_, T, A> where
    A: GlobalAlloc, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T, A, '_> Eq for TestBox<'_, T, A> where
    T: Eq,
    A: GlobalAlloc, 

impl<T, A, '_> Hash for TestBox<'_, T, A> where
    T: Hash,
    A: GlobalAlloc, 

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

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<T, A, '_> Ord for TestBox<'_, T, A> where
    T: Ord,
    A: GlobalAlloc, 

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T, A, '_> PartialEq<TestBox<'_, T, A>> for TestBox<'_, T, A> where
    T: PartialEq,
    A: GlobalAlloc, 

fn eq(&self, rh: &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<T, A, '_> PartialOrd<TestBox<'_, T, A>> for TestBox<'_, T, A> where
    T: PartialOrd,
    A: GlobalAlloc, 

fn partial_cmp(&self, rh: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

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

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