Struct SystemEventSet 

pub struct SystemEventSet(/* private fields */);

Implementations

impl SystemEventSet

pub fn register_events(&self, event_types: SystemEventTypes) -> Result<()>

Starts recording the requested events for the system event set.

For Linux only.

Starts recording events on the specified device. All events that occurred before this call are not recorded. Use SystemEventSet::wait to check whether an event occurred.

If NVML reports Status::Unknown, the event set is in an undefined state and must be freed. If NVML reports Status::NotSupported, the event set can still be used, but none of the requested event types are registered.

Errors

Returns an error if the installed NVML version does not support the request layout, if NVML rejects the event registration request, if NVML has not been initialized, or if NVML reports an unexpected failure.

pub fn wait( &self, timeout_ms: u32, max_events: u32, ) -> Result<Vec<SystemEventData>>

Waits for system events and returns ready events.

For Fermi or newer fully supported devices.

If events are ready when this is called, it returns immediately. If no events are ready, it sleeps until an event arrives or timeout_ms expires. In some conditions, such as an interrupt, this can return before the timeout expires.

If the returned event count equals the internal event-buffer capacity, there may be outstanding events. Call SystemEventSet::wait again to query all events.

Errors

Returns an error if the installed NVML version does not support the request layout, if NVML rejects the wait request, if no event arrives before timeout_ms, if NVML has not been initialized, or if NVML reports an unexpected failure.

Trait Implementations

impl Debug for SystemEventSet

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

Formats the value using the given formatter.

impl Drop for SystemEventSet

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.