Struct refpool::PoolBox

pub struct PoolBox<A> { /* fields omitted */ }

A unique pointer to a pool allocated value of A.

Methods

impl<A> PoolBox<A>

pub fn default(pool: &Pool<A>) -> Self where
    A: PoolDefault, 

Construct a PoolBox with a newly initialised value of A.

This uses PoolDefault::default_uninit() to initialise a default value, which may be faster than constructing a PoolBox from an existing value using PoolBox::new(), depending on the data type.

Examples

let pool: Pool<usize> = Pool::new(256);
let zero = PoolBox::default(&pool);
assert_eq!(0, *zero);

pub fn new(pool: &Pool<A>, value: A) -> Self

Wrap a value in a PoolBox.

This will copy the entire value into the memory handled by the PoolBox, which may be slower than using PoolBox::default(), so it's not recommended to use this to construct the default value.

Examples

let pool: Pool<usize> = Pool::new(256);
let number = PoolBox::new(&pool, 1337);
assert_eq!(1337, *number);

pub fn clone_from(pool: &Pool<A>, value: &A) -> Self where
    A: PoolClone, 

Clone a value and return a new PoolBox to it.

This will use PoolClone::clone_uninit() to perform the clone, which may be more efficient than using PoolBox::new(value.clone()).

Examples

let pool: Pool<Vec<usize>> = Pool::new(1);
let vec = vec![1, 2, 3];
let ref1 = PoolBox::clone_from(&pool, &vec);
assert_eq!(vec, *ref1);

pub fn pin_default(pool: &Pool<A>) -> Pin<Self> where
    A: PoolDefault, 

Construct a Pinned PoolBox with a default value.

Examples

let pool: Pool<usize> = Pool::new(256);
let zero = PoolBox::pin_default(&pool);
assert_eq!(0, *zero);

pub fn pin(pool: &Pool<A>, value: A) -> Pin<Self>

Construct a Pinned PoolBox with the given value.

Examples

let pool: Pool<usize> = Pool::new(256);
let number = PoolBox::pin(&pool, 1337);
assert_eq!(1337, *number);

pub fn ptr_eq(left: &Self, right: &Self) -> bool

Test two PoolBoxes for pointer equality.

Examples

let pool: Pool<usize> = Pool::new(1);
let ref1 = PoolBox::default(&pool);
assert!(PoolBox::ptr_eq(&ref1, &ref1));

pub fn into_raw_non_null(b: PoolBox<A>) -> NonNull<A>

Consume the PoolBox and return a pointer to the contents.

Please note that the only proper way to drop the value pointed to is by using PoolBox::from_raw to turn it back into a PoolBox, because the value is followed by PoolBox metadata which also needs to be dropped.

pub fn into_raw(b: PoolBox<A>) -> *mut A

Consume the PoolBox and return a pointer to the contents.

The pointer is guaranteed to be non-null.

Please note that the only proper way to drop the value pointed to is by using PoolBox::from_raw to turn it back into a PoolBox, because the value is followed by PoolBox metadata which also needs to be dropped.

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

Turn a raw pointer back into a PoolBox.

The pointer must be non-null and obtained from a previous call to PoolBox::into_raw or PoolBox::into_raw_non_null.

Safety

This must only be called on pointers obtained through PoolBox::into_raw. It's not OK to call it on a pointer to a value of A you've allocated yourself.

Examples

let pool: Pool<usize> = Pool::new(1);
let ref1 = PoolBox::new(&pool, 31337);

// Turn the PoolBox into a raw pointer and see if it still works.
let ptr = PoolBox::into_raw(ref1);
assert_eq!(31337, unsafe { *ptr });

// Turn it back into a PoolBox and see, again, if it still works.
let ref2 = unsafe { PoolBox::from_raw(ptr) };
assert_eq!(31337, *ref2);

Trait Implementations

impl<A> AsMut<A> for PoolBox<A>

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

Performs the conversion.

impl<A> AsRef<A> for PoolBox<A>

fn as_ref(&self) -> &A

Performs the conversion.

impl<A> Borrow<A> for PoolBox<A>

fn borrow(&self) -> &A

Immutably borrows from an owned value.

impl<A> BorrowMut<A> for PoolBox<A>

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

Mutably borrows from an owned value.

impl<A> Clone for PoolBox<A> where
    A: PoolClone, 

fn clone(&self) -> Self

Clone a PoolBox and its contents.

This will use PoolClone::clone_uninit() to perform the clone, which may be more efficient than using PoolBox::new(value.clone()).

Examples

let pool: Pool<Vec<usize>> = Pool::new(1);
let vec1 = PoolBox::new(&pool, vec![1, 2, 3]);
let vec2 = vec1.clone();
assert_eq!(vec1, vec2);

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

Performs copy-assignment from source.

impl<A> Debug for PoolBox<A> where
    A: Debug, 

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

Formats the value using the given formatter.

impl<A> Deref for PoolBox<A>

type Target = A

The resulting type after dereferencing.

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

Dereferences the value.

impl<A> DerefMut for PoolBox<A>

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

Mutably dereferences the value.

impl<A> Display for PoolBox<A> where
    A: Display, 

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

Formats the value using the given formatter.

impl<A> Drop for PoolBox<A>

fn drop(&mut self)

Executes the destructor for this type.

impl<A> Eq for PoolBox<A> where
    A: Eq, 

impl<A> Hash for PoolBox<A> where
    A: Hash, 

fn hash<H: Hasher>(&self, hasher: &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<A> Ord for PoolBox<A> where
    A: Ord, 

fn cmp(&self, other: &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<A> PartialEq<PoolBox<A>> for PoolBox<A> where
    A: PartialEq, 

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> PartialOrd<PoolBox<A>> for PoolBox<A> where
    A: PartialOrd, 

fn partial_cmp(&self, other: &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.

impl<A> Pointer for PoolBox<A>

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

Formats the value using the given formatter.