Struct Boxed

#[repr(C)]
pub struct Boxed<'a, T: ?Sized + 'a, A: Allocator = PoolAlloc> { /* private fields */ }

Implementations

impl<T> Boxed<'static, T, PoolAlloc>

pub fn new(val: T) -> Result<Self>

impl Boxed<'static, (), PoolAlloc>

利用函数的泛型参数方便推导出Boxed<’a, T, A>的类型参数

pub fn zeroed<T>() -> Result<Boxed<'static, MaybeUninit<T>, PoolAlloc>>

pub fn uninit<T>() -> Result<Boxed<'static, MaybeUninit<T>, PoolAlloc>>

pub fn zeroed_slice<T>( len: usize, ) -> Result<Boxed<'static, [MaybeUninit<T>], PoolAlloc>>

pub fn uninit_slice<T>( len: usize, ) -> Result<Boxed<'static, [MaybeUninit<T>], PoolAlloc>>

pub fn new_then<T, F>(f: F) -> Result<Boxed<'static, T, PoolAlloc>>

where F: FnOnce() -> Result<T>,

pub fn new_slice_then<T, F>( len: usize, f: F, ) -> Result<Boxed<'static, [T], PoolAlloc>>

where F: FnMut(usize) -> Result<T>,

impl Boxed<'static, [u8], PoolAlloc>

pub fn new_buf(layout: Layout) -> Result<Self>

pub fn new_buf_then<F>(layout: Layout, f: F) -> Result<Self>

where F: FnOnce(NonNull<[u8]>) -> Result<()>,

impl<T> Boxed<'static, [T], PoolAlloc>

pub fn new_slice(len: usize, val: T) -> Result<Self>

where T: Clone,

impl<'a, T, A: Allocator> Boxed<'a, T, A>

pub fn new_in(alloc: &'a A, val: T) -> Result<Self>

impl<'a, A: Allocator> Boxed<'a, (), A>

pub fn zeroed_in<T>(alloc: &'a A) -> Result<Boxed<'a, MaybeUninit<T>, A>>

pub fn uninit_in<T>(alloc: &'a A) -> Result<Boxed<'a, MaybeUninit<T>, A>>

pub fn zeroed_slice_in<T>( alloc: &'a A, len: usize, ) -> Result<Boxed<'a, [MaybeUninit<T>], A>>

pub fn uninit_slice_in<T>( alloc: &'a A, len: usize, ) -> Result<Boxed<'a, [MaybeUninit<T>], A>>

pub fn new_then_in<T, F>(alloc: &'a A, f: F) -> Result<Boxed<'a, T, A>>

where F: FnOnce() -> Result<T>,

pub fn new_slice_then_in<T, F>( alloc: &'a A, len: usize, f: F, ) -> Result<Boxed<'a, [T], A>>

where F: FnMut(usize) -> Result<T>,

impl<'a, A: Allocator> Boxed<'a, [u8], A>

pub fn new_buf_in(alloc: &'a A, layout: Layout) -> Result<Self>

pub fn new_buf_then_in<F>(alloc: &'a A, layout: Layout, f: F) -> Result<Self>

where F: FnOnce(NonNull<[u8]>) -> Result<()>,

impl<'a, T, A: Allocator> Boxed<'a, [T], A>

pub fn new_slice_in(alloc: &'a A, len: usize, val: T) -> Result<Self>

where T: Clone,

impl<'a, T> Boxed<'a, T, NullAlloc>

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

Safety

使用者保证data一定是有效的非空指针, 其所有权转移给Boxed返回值 但是其申请的内存不会被释放 如果需要正常释放内存，应该调用Boxed::from_with

impl<T> Boxed<'_, [T], NullAlloc>

pub unsafe fn from_raw_slice(data: *mut T, len: usize) -> Self

Safety

data and len should be valid slice

impl<'a, T, A: Allocator> Boxed<'a, MaybeUninit<T>, A>

pub fn write(self, val: T) -> Boxed<'a, T, A>

impl<'a, T, A: Allocator> Boxed<'a, [MaybeUninit<T>], A>

pub fn write_slice_then<F>(self, f: F) -> Result<Boxed<'a, [T], A>>

where F: FnMut(usize) -> Result<T>,

impl<'a, T: ?Sized + 'a, A: Allocator> Boxed<'a, T, A>

pub unsafe fn from_with(ptr: NonNull<T>, layout: Layout, alloc: &'a A) -> Self

Safety

用户保证(ptr, layout, alloc)是Boxed::leak的返回值

pub unsafe fn from_boxed(data: Boxed<'a, T, NullAlloc>, alloc: &'a A) -> Self

Safety

用户保证data是leak_boxed的返回值, 且是从alloc分配的内存

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

pub unsafe fn as_other<U>(&self) -> &U

Safety

使用人员需要保证类型内存布局相同

pub unsafe fn as_other_mut<U>(&mut self) -> &mut U

Safety

使用人员需要保证类型内存布局相同

pub unsafe fn as_slice<U>(&self, len: usize) -> &[U]

Safety

使用人员需要保证转换后类型/长度的正确性

pub unsafe fn as_slice_mut<U>(&mut self, len: usize) -> &mut [U]

Safety

使用人员需要保证转换后类型/长度的正确性

pub unsafe fn cast<U>(self) -> Result<Boxed<'a, U, A>, Self>

Safety

使用人员需要保证U/T的内存布局相同

pub unsafe fn cast_unchecked<U>(self) -> Boxed<'a, U, A>

Safety

使用人员需要保证U/T的内存布局相同, 可用于从某个trait转为为具体实现类场景.

pub unsafe fn cast_slice<U>(self, len: usize) -> Result<Boxed<'a, [U], A>, Self>

Safety

使用人员需要保证U/T的内存布局相同

pub unsafe fn cast_slice_unchecked<U>(self, len: usize) -> Boxed<'a, [U], A>

Safety

使用人员需要保证U/T的内存布局相同

pub fn leak(self) -> (&'a mut T, Layout, &'a A)

pub fn leak_boxed(self) -> Boxed<'a, T, NullAlloc>

资源所有权转移，但是其内存不会被释放

impl<'a, T: Any, A: Allocator> Boxed<'a, T, A>

pub fn to_any(self) -> Boxed<'a, dyn Any, A>

impl<'a, A: Allocator> Boxed<'a, dyn Any + 'a, A>

pub fn downcast<T: Any>(self) -> Result<Boxed<'a, T, A>, Self>

impl<'a, T: ?Sized, A: Allocator> Boxed<'a, T, A>

pub fn upcast<U: ?Sized>( self, f: impl FnOnce(&T) -> &U, ) -> Result<Boxed<'a, U, A>, Self>

用于实现到某个trait的转换.

impl<'a, T: ?Sized, A: Allocator> Boxed<'a, T, A>

pub fn layout(&self) -> Layout

Trait Implementations

impl<'a, T: ?Sized + Allocator, A: Allocator> Allocator for Boxed<'a, T, A>

unsafe fn free_buf(&self, ptr: NonNull<[u8]>, layout: Layout)

Safety

ptr一定时alloc_buf分配的内存地址

unsafe fn alloc_buf<F>(&self, layout: Layout, f: F) -> Result<NonNull<[u8]>>

where F: FnOnce(NonNull<[u8]>) -> Result<()>,

Safety

impl<T: ?Sized, A: Allocator> AsMut<T> for Boxed<'_, T, A>

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

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

impl<T: ?Sized, A: Allocator> AsRef<T> for Boxed<'_, T, A>

fn as_ref(&self) -> &T

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

impl<T: ?Sized + Debug, A: Allocator> Debug for Boxed<'_, T, A>

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

Formats the value using the given formatter.

impl<T: ?Sized, A: Allocator> Deref for Boxed<'_, T, A>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized, A: Allocator> DerefMut for Boxed<'_, T, A>

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

Mutably dereferences the value.

impl<T: ?Sized + Display, A: Allocator> Display for Boxed<'_, T, A>

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

Formats the value using the given formatter.

impl<T: ?Sized, A: Allocator> Drop for Boxed<'_, T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Hash, A: Allocator> Hash for Boxed<'_, 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: ?Sized + Hasher, A: Allocator> Hasher for Boxed<'_, T, A>

fn finish(&self) -> u64

Returns the hash value for the values written so far.

fn write(&mut self, bytes: &[u8])

Writes some data into this Hasher.

fn write_u8(&mut self, data: u8)

Writes a single u8 into this hasher.

fn write_u16(&mut self, data: u16)

Writes a single u16 into this hasher.

fn write_u32(&mut self, data: u32)

Writes a single u32 into this hasher.

fn write_u64(&mut self, data: u64)

Writes a single u64 into this hasher.

fn write_u128(&mut self, data: u128)

Writes a single u128 into this hasher.

fn write_usize(&mut self, data: usize)

Writes a single usize into this hasher.

fn write_isize(&mut self, data: isize)

Writes a single isize into this hasher.

fn write_i8(&mut self, data: i8)

Writes a single i8 into this hasher.

fn write_i16(&mut self, data: i16)

Writes a single i16 into this hasher.

fn write_i32(&mut self, data: i32)

Writes a single i32 into this hasher.

fn write_i64(&mut self, data: i64)

Writes a single i64 into this hasher.

fn write_i128(&mut self, data: i128)

Writes a single i128 into this hasher.

fn write_length_prefix(&mut self, len: usize)

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

Writes a length prefix into this hasher, as part of being prefix-free.

fn write_str(&mut self, s: &str)

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

Writes a single str into this hasher.

impl<T: ?Sized + Ord, A: Allocator> Ord for Boxed<'_, 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<T: ?Sized + PartialEq, A: Allocator> PartialEq for Boxed<'_, T, A>

fn eq(&self, other: &Self) -> 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<T: ?Sized + PartialOrd, A: Allocator> PartialOrd for Boxed<'_, T, A>

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

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

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

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

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

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

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

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

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

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

impl<T: ?Sized, A: Allocator> Pointer for Boxed<'_, T, A>

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

Formats the value using the given formatter.

impl<T: ?Sized + Eq, A: Allocator> Eq for Boxed<'_, T, A>

impl<T: ?Sized + Allocator + Pool, A: Allocator> Pool for Boxed<'_, T, A>

impl<T: ?Sized + Send, A: Allocator + Pool> Send for Boxed<'static, T, A>

impl<T: ?Sized + Sync, A: Allocator> Sync for Boxed<'static, T, A>

impl<T: ?Sized + Unpin, A: Allocator> Unpin for Boxed<'_, T, A>