Struct EventSuppression 

pub struct EventSuppression { /* private fields */ }

Event suppression structure for controlling notifications.

Implementations

impl EventSuppression

pub const SIZE: usize

pub const ALIGN: usize

pub const WRAP_OFFSET: usize

pub const FLAGS_OFFSET: usize

pub fn new(off_wrap: u16, flags: EventFlags) -> Self

Create a new event suppression with the given offset/wrap and flags.

pub fn flags(&self) -> EventFlags

Get the event flags.

pub fn set_flags(&mut self, flags: EventFlags)

Set the event flags.

pub fn desc_event_off(&self) -> u16

Get the descriptor event offset (bits 0-14).

pub fn desc_event_wrap(&self) -> bool

Check if the descriptor event wrap bit (bit 15) is set.

pub fn set_desc_event(&mut self, off: u16, wrap: bool)

Set the descriptor event offset and wrap bit.

pub fn read_flags_acquire<M: MemOps>( mem: &M, addr: u64, ) -> Result<EventFlags, M::Error>

Acquire-load only the flags word - the publish point - without reading the off_wrap payload.

Invariant

The caller must ensure that addr is a valid pointer to an EventSuppression.

pub fn read_body<M: MemOps>( mem: &M, addr: u64, flags: EventFlags, ) -> Result<Self, M::Error>

Read the off_wrap payload and combine it with flags already obtained from read_flags_acquire.

Invariant

The caller must ensure that addr is a valid pointer to an EventSuppression.

pub fn write_release<M: MemOps>( &self, mem: &M, addr: u64, ) -> Result<(), M::Error>

Write an EventSuppression to a raw pointer with release semantics.

Invariant

The caller must ensure that base is a valid pointer to an EventSuppression.

Trait Implementations

impl Clone for EventSuppression

fn clone(&self) -> EventSuppression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EventSuppression

impl Debug for EventSuppression

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

Formats the value using the given formatter.

impl Eq for EventSuppression

impl Hash for EventSuppression

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventSuppression

fn eq(&self, other: &EventSuppression) -> 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.

impl Pod for EventSuppression

impl StructuralPartialEq for EventSuppression

impl Zeroable for EventSuppression

fn zeroed() -> Self

Calls zeroed.