Struct Arena

pub struct Arena { /* private fields */ }

Arena should be lock-free

Trait Implementations

impl Allocator for Arena

type Path = Arc<PathBuf>

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

The path type of the allocator.

fn reserved_bytes(&self) -> usize

Returns the number of bytes that are reserved by the allocator.

fn reserved_slice(&self) -> &[u8]

Returns the reserved bytes of the allocator specified in the Options::with_reserved.

unsafe fn reserved_slice_mut(&self) -> &mut [u8]

Returns the mutable reserved bytes of the allocator specified in the Options::with_reserved.

unsafe fn alloc<T>(&self) -> Result<RefMut<'_, T, Self>, Error>

Allocates a T in the allocator.

fn alloc_aligned_bytes<T>( &self, size: u32, ) -> Result<BytesRefMut<'_, Self>, Error>

Allocates a byte slice that can hold a well-aligned T and extra size bytes.

fn alloc_bytes(&self, size: u32) -> Result<BytesRefMut<'_, Self>, Error>

Allocates a slice of memory in the allocator.

fn allocated(&self) -> usize

Returns the number of bytes allocated by the allocator.

fn raw_mut_ptr(&self) -> *mut u8

Returns the start pointer of the main memory of the allocator.

fn raw_ptr(&self) -> *const u8

Returns the start pointer of the main memory of the allocator.

unsafe fn clear(&self) -> Result<(), Error>

Clear the allocator.

unsafe fn dealloc(&self, offset: u32, size: u32) -> bool

Deallocates the memory at the given offset and size, the offset..offset + size will be made to a segment, returns true if the deallocation is successful.

fn discard_freelist(&self) -> Result<u32, Error>

Discards all freelist nodes in the allocator.

fn discarded(&self) -> u32

Returns the number of bytes discarded by the allocator.

fn increase_discarded(&self, size: u32)

Forcelly increases the discarded bytes.

fn magic_version(&self) -> u16

Returns the magic version of the allocator. This value can be used to check the compatibility for application using Allocator.

fn minimum_segment_size(&self) -> u32

Returns the minimum segment size of the allocator.

fn set_minimum_segment_size(&self, size: u32)

Sets the minimum segment size of the allocator.

fn path(&self) -> Option<&Self::Path>

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

Returns the path of the mmap file, only returns Some when the ARENA is backed by a mmap file.

unsafe fn offset(&self, ptr: *const u8) -> usize

Returns the offset to the start of the allocator.

fn page_size(&self) -> usize

Returns the page size.

fn read_only(&self) -> bool

Returns true if the arena is read-only.

fn refs(&self) -> usize

Returns the number of references to the allocator.

fn remaining(&self) -> usize

Returns the number of bytes remaining bytes can be allocated by the allocator.

unsafe fn rewind(&self, pos: ArenaPosition)

Set back the allocator’s main memory cursor to the given position.

fn version(&self) -> u16

Returns the version of the allocator.

fn alloc_aligned_bytes_owned<T>( &self, size: u32, ) -> Result<BytesMut<Self>, Error>

Allocates an owned byte slice that can hold a well-aligned T and extra size bytes.

fn alloc_bytes_owned(&self, size: u32) -> Result<BytesMut<Self>, Error>

Allocates an owned slice of memory in the allocator.

unsafe fn alloc_owned<T>(&self) -> Result<Owned<T, Self>, Error>

Allocates a T in the allocator. Like alloc, but returns an Owned.

fn allocated_memory(&self) -> &[u8]

Returns the whole main memory of the allocator as a byte slice.

fn capacity(&self) -> usize

Returns the capacity of the allocator.

fn data_offset(&self) -> usize

Returns the data offset of the allocator. The offset is the end of the reserved bytes of the allocator.

fn data(&self) -> &[u8]

Returns the data section of the allocator as a byte slice, header is not included.

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

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

Flushes the memory-mapped file to disk.

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

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

Flushes the memory-mapped file to disk asynchronously.

fn flush_range(&self, offset: usize, len: usize) -> Result<()>

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

Flushes outstanding memory map modifications in the range to disk.

fn flush_async_range(&self, offset: usize, len: usize) -> Result<()>

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

Asynchronously flushes outstanding memory map modifications in the range to disk.

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

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

Flushes outstanding memory map modifications in Allocator’s header to disk.

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

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

Asynchronously flushes outstanding memory map modifications Allocator’s header to disk.

fn flush_header_and_range(&self, offset: usize, len: usize) -> Result<()>

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

Flushes outstanding memory map modifications in the range and Allocator’s header to disk.

fn flush_async_header_and_range(&self, offset: usize, len: usize) -> Result<()>

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

Asynchronously flushes outstanding memory map modifications in the range and Allocator’s header to disk.

unsafe fn get_pointer(&self, offset: usize) -> *const u8

Returns a pointer to the memory at the given offset.

unsafe fn get_pointer_mut(&self, offset: usize) -> *mut u8

Returns a pointer to the memory at the given offset. If the allocator is read-only, then this method will return a null pointer.

unsafe fn get_aligned_pointer<T>(&self, offset: usize) -> *const T

Returns an aligned pointer to the memory at the given offset.

unsafe fn get_aligned_pointer_mut<T>(&self, offset: usize) -> NonNull<T>

Returns an aligned pointer to the memory at the given offset. If the allocator is read-only, then this method will return a null pointer.

unsafe fn get_bytes(&self, offset: usize, size: usize) -> &[u8]

Returns a bytes slice from the allocator.

fn get_u8(&self, offset: usize) -> Result<u8, Error>

Returns a u8 from the allocator.

fn get_i8(&self, offset: usize) -> Result<i8, Error>

Returns a i8 from the allocator.

unsafe fn get_u8_unchecked(&self, offset: usize) -> u8

Returns a u8 from the allocator without bounds checking.

unsafe fn get_i8_unchecked(&self, offset: usize) -> i8

Returns a i8 from the allocator without bounds checking.

fn get_u16_be(&self, offset: usize) -> Result<u16, Error>

Returns a u16 from the allocator.

unsafe fn get_u16_be_unchecked(&self, offset: usize) -> u16

Returns a u16 from the allocator without bounds checking.

fn get_u16_le(&self, offset: usize) -> Result<u16, Error>

Returns a u16 from the allocator.

unsafe fn get_u16_le_unchecked(&self, offset: usize) -> u16

Returns a u16 from the allocator without bounds checking.

fn get_u32_be(&self, offset: usize) -> Result<u32, Error>

Returns a u32 from the allocator.

unsafe fn get_u32_be_unchecked(&self, offset: usize) -> u32

Returns a u32 from the allocator without bounds checking.

fn get_u32_le(&self, offset: usize) -> Result<u32, Error>

Returns a u32 from the allocator.

unsafe fn get_u32_le_unchecked(&self, offset: usize) -> u32

Returns a u32 from the allocator without bounds checking.

fn get_u64_be(&self, offset: usize) -> Result<u64, Error>

Returns a u64 from the allocator.

unsafe fn get_u64_be_unchecked(&self, offset: usize) -> u64

Returns a u64 from the allocator without bounds checking.

fn get_u64_le(&self, offset: usize) -> Result<u64, Error>

Returns a u64 from the allocator.

unsafe fn get_u64_le_unchecked(&self, offset: usize) -> u64

Returns a u64 from the allocator without bounds checking.

fn get_u128_be(&self, offset: usize) -> Result<u128, Error>

Returns a u128 from the allocator.

unsafe fn get_u128_be_unchecked(&self, offset: usize) -> u128

Returns a u128 from the allocator without bounds checking.

fn get_u128_le(&self, offset: usize) -> Result<u128, Error>

Returns a u128 from the allocator.

unsafe fn get_u128_le_unchecked(&self, offset: usize) -> u128

Returns a u128 from the allocator without bounds checking.

fn get_i16_be(&self, offset: usize) -> Result<i16, Error>

Returns a i16 from the allocator.

unsafe fn get_i16_be_unchecked(&self, offset: usize) -> i16

Returns a i16 from the allocator without bounds checking.

fn get_i16_le(&self, offset: usize) -> Result<i16, Error>

Returns a i16 from the allocator.

unsafe fn get_i16_le_unchecked(&self, offset: usize) -> i16

Returns a i16 from the allocator without bounds checking.

fn get_i32_be(&self, offset: usize) -> Result<i32, Error>

Returns a i32 from the allocator.

unsafe fn get_i32_be_unchecked(&self, offset: usize) -> i32

Returns a i32 from the allocator without bounds checking.

fn get_i32_le(&self, offset: usize) -> Result<i32, Error>

Returns a i32 from the allocator.

unsafe fn get_i32_le_unchecked(&self, offset: usize) -> i32

Returns a i32 from the allocator without bounds checking.

fn get_i64_be(&self, offset: usize) -> Result<i64, Error>

Returns a i64 from the allocator.

unsafe fn get_i64_be_unchecked(&self, offset: usize) -> i64

Returns a i64 from the allocator without bounds checking.

fn get_i64_le(&self, offset: usize) -> Result<i64, Error>

Returns a i64 from the allocator.

unsafe fn get_i64_le_unchecked(&self, offset: usize) -> i64

Returns a i64 from the allocator without bounds checking.

fn get_i128_be(&self, offset: usize) -> Result<i128, Error>

Returns a i128 from the allocator.

unsafe fn get_i128_be_unchecked(&self, offset: usize) -> i128

Returns a i128 from the allocator without bounds checking.

fn get_i128_le(&self, offset: usize) -> Result<i128, Error>

Returns a i128 from the allocator.

unsafe fn get_i128_le_unchecked(&self, offset: usize) -> i128

Returns a i128 from the allocator without bounds checking.

fn get_i16_varint(&self, offset: usize) -> Result<(usize, i16), Error>

Returns a i16 in LEB128 format from the allocator at the given offset.

fn get_i32_varint(&self, offset: usize) -> Result<(usize, i32), Error>

Returns a i32 in LEB128 format from the allocator at the given offset.

fn get_i64_varint(&self, offset: usize) -> Result<(usize, i64), Error>

Returns a i64 in LEB128 format from the allocator at the given offset.

fn get_i128_varint(&self, offset: usize) -> Result<(usize, i128), Error>

Returns a i128 in LEB128 format from the allocator at the given offset.

fn get_u16_varint(&self, offset: usize) -> Result<(usize, u16), Error>

Returns a u16 in LEB128 format from the allocator at the given offset.

fn get_u32_varint(&self, offset: usize) -> Result<(usize, u32), Error>

Returns a u32 in LEB128 format from the allocator at the given offset.

fn get_u64_varint(&self, offset: usize) -> Result<(usize, u64), Error>

Returns a u64 in LEB128 format from the allocator at the given offset.

fn get_u128_varint(&self, offset: usize) -> Result<(usize, u128), Error>

Returns a u128 in LEB128 format from the allocator at the given offset.

unsafe fn get_bytes_mut(&self, offset: usize, size: usize) -> &mut [u8]

Returns a mutable bytes slice from the allocator. If the allocator is read-only, then this method will return an empty slice.

fn is_map(&self) -> bool

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

Returns true if the allocator is created through memory map.

fn is_ondisk(&self) -> bool

Returns true if the allocator is on disk.

fn is_inmemory(&self) -> bool

Returns true if the allocator is in memory.

fn is_map_anon(&self) -> bool

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

Returns true if the allocator is on-disk and created through memory map.

fn is_map_file(&self) -> bool

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

Returns true if the allocator is on-disk and created through memory map.

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

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

Locks the underlying file for exclusive access, only works on mmap with a file backend.

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

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

Locks the underlying file for shared access, only works on mmap with a file backend.

fn memory(&self) -> &[u8]

Returns the whole main memory of the allocator as a byte slice.

fn checksum<S: BuildChecksumer>(&self, cks: &S) -> u64

Calculates the checksum of the allocated memory (excluding the reserved memory specified by users through Options::with_reserved) of the allocator.

fn unify(&self) -> bool

Returns true if the allocator is unify memory layout.

unsafe fn mlock(&self, offset: usize, len: usize) -> Result<()>

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

mlock(ptr, len)—Lock memory into RAM.

unsafe fn munlock(&self, offset: usize, len: usize) -> Result<()>

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

munlock(ptr, len)—Unlock memory.

fn remove_on_drop(&self, remove_on_drop: bool)

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

Sets remove on drop, only works on mmap with a file backend.

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

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

Try to lock the underlying file for exclusive access, only works on mmap with a file backend.

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

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

Try to lock the underlying file for shared access, only works on mmap with a file backend.

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

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

Unlocks the underlying file, only works on mmap with a file backend.

impl Clone for Arena

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arena

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

Formats the value using the given formatter.

impl Drop for Arena

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Arena

impl Sync for Arena