Enum interruptible::Interruptibility

pub enum Interruptibility<'rx> {
    NonInterruptible,
    Interruptible {
        interrupt_rx: OwnedOrMutRef<'rx, Receiver<InterruptSignal>>,
        interrupt_strategy: InterruptStrategy,
    },
}

Specifies interruptibility support of the application.

This is the dynamic / non-type-parameterized version of interruptibility.

Variants

NonInterruptible

Interruptions are not supported.

Interruptible

Fields

interrupt_rx: OwnedOrMutRef<'rx, Receiver<InterruptSignal>>

Channel receiver of the interrupt signal.

interrupt_strategy: InterruptStrategy

How to poll the underlying stream when an interruption is received.

Interruptions are supported.

Implementations

impl<'rx> Interruptibility<'rx>

pub fn new( interrupt_rx: OwnedOrMutRef<'rx, Receiver<InterruptSignal>>, interrupt_strategy: InterruptStrategy ) -> Self

Returns a new Interruptibility::Interruptible.

pub fn finish_current( interrupt_rx: OwnedOrMutRef<'rx, Receiver<InterruptSignal>> ) -> Self

Returns a new Interruptibility::Interruptible using the InterruptStrategy::FinishCurrent strategy.

pub fn poll_next_n( interrupt_rx: OwnedOrMutRef<'rx, Receiver<InterruptSignal>>, n: u64 ) -> Self

Returns a new Interruptibility::Interruptible using the InterruptStrategy::FinishCurrent strategy.

pub fn reborrow(&mut self) -> Interruptibility<'_>

Reborrows this Interruptibility with a shorter lifetime.

pub fn interrupt_strategy(&self) -> Option<InterruptStrategy>

Returns the InterruptStrategy if present.

Trait Implementations

impl<'rx> Debug for Interruptibility<'rx>

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

Formats the value using the given formatter.

impl<'rx> From<Interruptibility<'rx>> for InterruptibilityState<'rx, 'static>

fn from(interruptibility: Interruptibility<'rx>) -> Self

Returns a new InterruptibilityState.