Struct rarena_allocator::Owned

pub struct Owned<T> { /* private fields */ }

An owned to a value T in the ARENA.

Implementations

impl<T> Owned<T>

pub unsafe fn detach(&mut self)

Detach the value from the ARENA, which means when the value is dropped, the underlying memory will not be collected for futhur allocation.

Safety

• If T is not inlined (core::mem::needs_drop::<T>() returns true), then users should take care of dropping the value by themselves.

pub fn write(&mut self, value: T)

Write a value to the RefMut.

pub const fn size(&self) -> usize

Returns how many bytes of T occupies.

If this value is 0, then the T is ZST (zero sized type).

pub const fn offset(&self) -> usize

Returns the offset of T to the pointer of the ARENA.

If this value is 0, then the T is ZST (zero sized type).

pub const fn memory_size(&self) -> usize

Returns how many bytes of memory the value occupies.

If this value is 0, then the T is ZST (zero sized type).

pub const fn memory_offset(&self) -> usize

Returns the offset to the pointer of the ARENA.

If this value is 0, then the T is ZST (zero sized type).

pub unsafe fn as_ref(&self) -> &T

Returns a shared reference to the value.

Safety

• The value must be initialized.

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

Returns a mutable reference to the value.

Safety

• The value must be initialized.

pub fn as_mut_ptr(&mut self) -> NonNull<T>

Returns the pointer to the T, the pointer may not be initialized. If the pointer is not initialized, then NonNull::dangling() is returned.

Trait Implementations

impl<T: Debug> Debug for Owned<T>

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

Formats the value using the given formatter.

impl<T> Drop for Owned<T>

fn drop(&mut self)

Executes the destructor for this type.