Struct Interrupt

pub struct Interrupt { /* private fields */ }

An interrupt.

This is output by an implementation of ExternalDevice::poll_interrupt if an interrupt should occur.

Implementations

impl Interrupt

pub fn vectored(vect: u8, priority: u8) -> Self

Creates a new vectored interrupt.

Note that the priority is truncated to 3 bits.

pub fn external(e: impl Error + Send + Sync + 'static) -> Self

Creates a new external interrupt (one not handled by the OS).

When this type of interrupt is raised, the simulator raises SimErr::Interrupt which can be used to handle the resulting InterruptErr.

One example where this is used is in Python bindings. In that case, we want to be able to halt the Simulator on a KeyboardInterrupt. However, by default, Python cannot signal to the Rust library that a KeyboardInterrupt has occurred. Thus, we can add a signal handler as an external interrupt to allow the KeyboardInterrupt to be handled properly.

pub fn priority(&self) -> Option<u8>

Calculates the priority for a given interrupt.

• For all vectored interrupts, this is the three least-significant bits of the priority value.
• For external interrupts, this is None

Trait Implementations

impl Debug for Interrupt

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

Formats the value using the given formatter.