Struct SeaBoxIn 

pub struct SeaBoxIn<T, A: Allocator> { /* private fields */ }

Owned, aligned pointer to a T, which is freed on Drop.

The allocator is pluggable - see Allocator.

#[repr(transparent)] such that Option<SeaBox<T>> has the same layout as *mut T.

Implementations

impl<T, A: Allocator> SeaBoxIn<T, A>

pub fn new(t: T) -> Self

Available on crate feature alloc only.

Copy t into the heap.

pub fn try_new(t: T) -> Result<Self, AllocError>

pub unsafe fn try_emplace( f: impl FnOnce(&mut MaybeUninit<T>), ) -> Result<Self, AllocError>

Safety

• Must initialize the given memory.

Note that if T is a ZST, the passed in memory is ephemeral.

pub fn unbox(self) -> T

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

Safety

• Must have been allocated by A.
• Must be a valid T.
• This must be the only pointer to the allocation.

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

Trait Implementations

impl<T, A: Allocator> AsMut<T> for SeaBoxIn<T, A>

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

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

impl<T, A: Allocator> AsRef<T> for SeaBoxIn<T, A>

fn as_ref(&self) -> &T

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

impl<T, A: Allocator> Borrow<T> for SeaBoxIn<T, A>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, A: Allocator> BorrowMut<T> for SeaBoxIn<T, A>

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

Mutably borrows from an owned value.

impl<T: Debug, A: Allocator> Debug for SeaBoxIn<T, A>

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

Formats the value using the given formatter.

impl<T, A: Allocator> Deref for SeaBoxIn<T, A>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, A: Allocator> DerefMut for SeaBoxIn<T, A>

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

Mutably dereferences the value.

impl<T: Display, A: Allocator> Display for SeaBoxIn<T, A>

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

Formats the value using the given formatter.

impl<T, A: Allocator> Drop for SeaBoxIn<T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Hash, A: Allocator> Hash for SeaBoxIn<T, A>

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<T: Ord, A: Allocator> Ord for SeaBoxIn<T, A>

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,

Restrict a value to a certain interval.

impl<T1, T2, A1: Allocator, A2: Allocator> PartialEq<SeaBoxIn<T2, A2>> for SeaBoxIn<T1, A1>

where T1: PartialEq<T2>,

fn eq(&self, other: &SeaBoxIn<T2, A2>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T1, T2, A1: Allocator, A2: Allocator> PartialOrd<SeaBoxIn<T2, A2>> for SeaBoxIn<T1, A1>

where T1: PartialOrd<T2>,

fn partial_cmp(&self, other: &SeaBoxIn<T2, A2>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Eq, A: Allocator> Eq for SeaBoxIn<T, A>

impl<T: Send, A: Allocator + Send> Send for SeaBoxIn<T, A>

impl<T: Sync, A: Allocator + Sync> Sync for SeaBoxIn<T, A>