Struct elfo::time::Delay

pub struct Delay<M> { /* private fields */ }

A source that emits a message after some specified time.

Tracing

The emitted message continues the current trace.

Example

use elfo::time::Delay;

#[message]
struct MyTick;

while let Some(envelope) = ctx.recv().await {
    msg!(match envelope {
        SomeEvent => {
            ctx.attach(Delay::new(ctx.config().delay, MyTick));
        },
        MyTick => {
            tracing::info!("tick!");
        },
    });
}

Implementations

impl<M> Delay<M>where M: Message,

pub fn new(delay: Duration, message: M) -> UnattachedSource<Delay<M>>

Schedules the timer to emit the provided message after delay.

Creates an unattached instance of Delay.

pub fn until(when: Instant, message: M) -> UnattachedSource<Delay<M>>

Schedules the timer to emit the provided message at when.

Creates an unattached instance of Delay.

Stability

This method is unstable, because it accepts [tokio::time::Instant], which will be replaced in the future to support other runtimes.

Availability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl<M> SourceHandle for Delay<M>where M: Message,

fn is_terminated(&self) -> bool

Returns true if the source has stopped producing messages.

fn terminate(self)

Terminates the source. Drop is called immediately.