Struct IrqSelection

Source
pub struct IrqSelection(/* private fields */);
Expand description

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§

Source§

impl IrqSelection

Source

pub const NONE: IrqSelection

Represents a selection with no IRQs.

Source

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

Creates a new IRQ selection with the specified IRQ included.

Source

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

Add an IRQ number by selection.

Source

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

Check if an IRQ number is set.

Source

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

Iterate over the IRQs that are set.

Trait Implementations§

Source§

impl Clone for IrqSelection

Source§

fn clone(&self) -> IrqSelection

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IrqSelection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IrqSelection

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<u32> for IrqSelection

Source§

fn from(value: u32) -> Self

Intialize an IRQ selection from a raw value.

Source§

impl PartialEq for IrqSelection

Source§

fn eq(&self, other: &IrqSelection) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for IrqSelection

Source§

impl Eq for IrqSelection

Source§

impl StructuralPartialEq for IrqSelection

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.