Struct relm4::shutdown::AttachedShutdown

pub struct AttachedShutdown<F> { /* private fields */ }

A future attached to a shutdown receiver.

Implementations

impl<F, Out> AttachedShutdown<F>where
    F: Future<Output = Out>,

pub async fn on_shutdown<S>(self, shutdown: S) -> Outwhere
    S: Future<Output = Out>,

Creates a future which will resolve to this on shutdown.

pub async fn wait(self) -> Either<(), Out>

Waits until a shutdown signal is received.

• Either::Left(()) on cancellation.
• Either::Right(Out) on registered future completion.

pub async fn drop_on_shutdown(self)

Waits until a shutdown signal is received.

Ignores any output when we don’t care about it.

Trait Implementations

impl<F: Debug> Debug for AttachedShutdown<F>

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

Formats the value using the given formatter.