Struct RegDescList 

pub struct RegDescList<'a> { /* private fields */ }

A safe wrapper around a NIXL registration descriptor list

Implementations

impl<'a> RegDescList<'a>

pub fn new(mem_type: MemType) -> Result<Self, NixlError>

Creates a new registration descriptor list for the given memory type

pub fn get_type(&self) -> Result<MemType, NixlError>

pub fn add_desc(&mut self, addr: usize, len: usize, dev_id: u64)

Adds a descriptor to the list

pub fn add_desc_with_meta( &mut self, addr: usize, len: usize, dev_id: u64, metadata: &[u8], )

Add a descriptor with metadata

pub fn is_empty(&self) -> Result<bool, NixlError>

Returns true if the list is empty

pub fn desc_count(&self) -> Result<usize, NixlError>

Returns the number of descriptors in the list

pub fn len(&self) -> Result<usize, NixlError>

Returns the number of descriptors in the list

pub fn trim(&mut self)

Trims the list to the given size

pub fn rem_desc(&mut self, index: i32) -> Result<(), NixlError>

Removes the descriptor at the given index

pub fn print(&self) -> Result<(), NixlError>

Prints the list contents

pub fn clear(&mut self)

Clears all descriptors from the list

pub fn resize(&mut self, new_size: usize)

Resizes the list to the given size

pub fn get(&self, index: usize) -> Result<&RegDescriptor, NixlError>

Safe immutable access to descriptor by index

pub fn get_mut(&mut self, index: usize) -> Result<&mut RegDescriptor, NixlError>

Safe mutable access to descriptor by index

pub fn add_storage_desc( &mut self, desc: &'a dyn NixlDescriptor, ) -> Result<(), NixlError>

Add a descriptor from a type implementing NixlDescriptor

Safety

The caller must ensure that:

• The descriptor remains valid for the lifetime of the list
• The memory region pointed to by the descriptor remains valid

pub fn serialize(&self) -> Result<Vec<u8>, NixlError>

Serializes the descriptor list to a byte vector using bincode

pub fn deserialize(bytes: &[u8]) -> Result<Self, NixlError>

Deserializes a descriptor list from a byte slice using bincode

Trait Implementations

impl Debug for RegDescList<'_>

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

Formats the value using the given formatter.

impl Drop for RegDescList<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Index<usize> for RegDescList<'_>

type Output = RegDescriptor

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for RegDescList<'_>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for RegDescList<'_>

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.