Struct rarena_allocator::RefMut

pub struct RefMut<'a, T, A: Allocator> { /* private fields */ }

A mutable reference to a value T in the ARENA.

Implementations

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

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

Write a value to the RefMut.

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<'a, T: Debug, A: Debug + Allocator> Debug for RefMut<'a, T, A>

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

Formats the value using the given formatter.

impl<'a, T, A: Allocator> Drop for RefMut<'a, T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T, A: Allocator> Memory for RefMut<'a, T, A>

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.

fn capacity(&self) -> usize

Returns how many bytes of accessible memory occupies.

fn offset(&self) -> usize

Returns the accessible offset to the pointer of the allocator.

fn memory_capacity(&self) -> usize

Returns how many bytes of the whole memory occupies.

fn memory_offset(&self) -> usize

Returns the offset to the pointer of the allocator.

fn flush(&self) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

Flush the buffer to the disk.

fn flush_async(&self) -> Result<()>

Available on crate feature memmap and non-target_family="wasm" only.

Asynchronously flush the buffer to the disk.