Struct relm4::ShutdownReceiver

pub struct ShutdownReceiver { /* private fields */ }

Listens to shutdown signals and constructs shutdown futures.

Implementations

impl ShutdownReceiver

pub fn register<F>(self, future: F) -> AttachedShutdown<F>

Create a future which will be cancelled on shutdown.

Examples found in repository

src/channel/component.rs (line 116)

    pub fn oneshot_command<Fut>(&self, future: Fut)
    where
        Fut: Future<Output = CommandOutput> + Send + 'static,
    {
        // Async closures would be awesome here...
        self.command(move |out, shutdown| {
            shutdown
                .register(async move { out.send(future.await) })
                .drop_on_shutdown()
        });
    }

pub async fn wait(self)

Waits until a shutdown signal is received.

Examples found in repository

src/channel/shutdown/attached.rs (line 37)

    pub async fn wait(self) -> Either<(), Out> {
        let Self { receiver, future } = self;

        let cancel = receiver.wait();
        futures::pin_mut!(cancel);
        futures::pin_mut!(future);

        match futures::future::select(cancel, future).await {
            Either::Left(_) => Either::Left(()),
            Either::Right((out, _)) => Either::Right(out),
        }
    }

Trait Implementations

impl Clone for ShutdownReceiver

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownReceiver

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

Formats the value using the given formatter.