Struct IrqSelection

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

Represents a selection of 0 or more IRQs.

Internally the FPGA API expects a bitwise field to select IRQs. This type wraps that representation with functions to help make different selections and conversions.

For single IRQs you can use IrqSelection::new and to query if they are set use IrqSelection::is_irq_set.

use ni_fpga_interface::irq::IrqSelection;
let selection = IrqSelection::new(2);
assert_eq!(selection.is_irq_set(2), true);

There is also an iterator method if you want to cycle through the set IRQs.

use ni_fpga_interface::irq::IrqSelection;
let mut selection = IrqSelection::new(0);
selection.add_irq(2);
for irq in selection.iter() {
   println!("IRQ: {}", irq);
}

To mimic the C API the IRQs are also available as constants.

use ni_fpga_interface::irq::{IRQ1};
assert_eq!(IRQ1.is_irq_set(1), true);

Implementations

impl IrqSelection

pub const NONE: IrqSelection

Represents a selection with no IRQs.

pub const fn new(irq: u8) -> IrqSelection

Creates a new IRQ selection with the specified IRQ included.

pub fn add_irq(&mut self, irq: u8)

Add an IRQ number by selection.

pub fn is_irq_set(&self, irq: u8) -> bool

Check if an IRQ number is set.

pub fn iter(&self) -> impl Iterator<Item = u8> + '_

Iterate over the IRQs that are set.

Trait Implementations

impl Clone for IrqSelection

fn clone(&self) -> IrqSelection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IrqSelection

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

Formats the value using the given formatter.

impl Default for IrqSelection

fn default() -> Self

Returns the “default value” for a type.

impl From<u32> for IrqSelection

fn from(value: u32) -> Self

Intialize an IRQ selection from a raw value.

impl PartialEq for IrqSelection

fn eq(&self, other: &IrqSelection) -> 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 Copy for IrqSelection

impl Eq for IrqSelection

impl StructuralPartialEq for IrqSelection