Struct ArenaBuffer 

pub struct ArenaBuffer<S: MemoryDescription> { /* private fields */ }

A buffer allocated from an ArenaAllocator.

This struct wraps an Allocation from the offset_allocator crate, and provides methods for interacting with the allocated memory.

The buffer is backed by a MemoryDescription object, and the allocation is freed when the buffer is dropped.

Implementations

impl<S> ArenaBuffer<S>

where S: MemoryDescription + NixlCompatible,

pub fn nixl_descriptor(&self) -> Option<NixlDescriptor>

Create a NIXL descriptor for this buffer with the correct offset and size.

This can be used when the base storage implements NixlCompatible to create a descriptor that points to just this buffer’s region.

impl<S> ArenaBuffer<S>

where S: MemoryDescription + RegisteredView,

pub fn agent_name(&self) -> &str

Get the agent name from registered storage.

This is a convenience method when using ArenaAllocator with NixlRegistered storage.

pub fn registered_descriptor(&self) -> NixlDescriptor

Get a NIXL descriptor that includes registration information.

Trait Implementations

impl<S: MemoryDescription> Debug for ArenaBuffer<S>

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

Formats the value using the given formatter.

impl<S: MemoryDescription> Drop for ArenaBuffer<S>

fn drop(&mut self)

Executes the destructor for this type.

impl<S: MemoryDescription + 'static> MemoryDescription for ArenaBuffer<S>

fn addr(&self) -> usize

Base address of the memory region.

fn size(&self) -> usize

Size of the memory region in bytes.

fn storage_kind(&self) -> StorageKind

Type of storage backing this region.

fn as_any(&self) -> &dyn Any

Enable downcasting to concrete type.

fn nixl_descriptor(&self) -> Option<NixlDescriptor>

Get the NIXL descriptor for this memory region.