pub struct InterruptHandler { /* private fields */ }
Expand description

Interrupt handler.

Receives the interrupts produced by the FPGA IP core and sends notifications to the InterruptWaiters. It is necessary to call InterruptHandler::run in order to receive and process interrupts.

§Examples

This shows how to create an InterruptHandler, obtain an InterruptWaiter, and wait for an interrupt, while running the InterruptHandler concurrently in a Tokio task.

use maia_httpd::fpga::IpCore;

let (ip_core, interrupt_handler) = IpCore::take().await?;
let waiter = interrupt_handler.waiter_recorder();
tokio::spawn(async move { interrupt_handler.run() });
waiter.wait().await;

Implementations§

source§

impl InterruptHandler

source

pub async fn run(self) -> Result<()>

Runs the interrupt handler.

This function only returns if there is an error.

The function must be run concurrently with the rest of the application so that interrupts can be received and notifications can be sent to the waiters.

source

pub fn waiter_spectrometer(&self) -> InterruptWaiter

Returns a waiter for the spectrometer interrupt.

source

pub fn waiter_recorder(&self) -> InterruptWaiter

Returns a waiter for the recorder interrupt.

Trait Implementations§

source§

impl Debug for InterruptHandler

source§

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

Formats the value using the given formatter. Read more

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more