Struct NotificationMap 

pub struct NotificationMap { /* private fields */ }

A safe wrapper around NIXL notification map

Implementations

impl NotificationMap

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

Creates a new empty notification map

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

Returns the number of agents that have notifications

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

Returns true if there are no notifications

pub fn agents(&self) -> NotificationMapAgentIterator<'_>

Returns an iterator over the agent names that have notifications

pub fn get_notifications_size( &self, agent_name: &str, ) -> Result<usize, NixlError>

Returns the number of notifications for a given agent

pub fn get_notifications( &self, agent_name: &str, ) -> Result<NotificationIterator<'_>, NixlError>

Returns an iterator over the notifications for a given agent

pub fn get_notification_bytes( &self, agent_name: &str, index: usize, ) -> Result<Vec<u8>, NixlError>

Returns a specific notification for a given agent as raw bytes

pub fn take_notifs(&mut self) -> Result<HashMap<String, Vec<String>>, NixlError>

Takes all notifications from the map, converting them to Strings, and clears the underlying C map for reuse.

Returns a HashMap where keys are agent names and values are vectors of notification strings for that agent.

If a notification's byte data is not valid UTF-8, this method will return an error (NixlError::BackendError in current impl, ideally a specific UTF-8 error).

Trait Implementations

impl Drop for NotificationMap

fn drop(&mut self)

Executes the destructor for this type.