Skip to main content

Delay

Struct Delay 

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

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§

Source§

impl<M: Message> Delay<M>

Source

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

Schedules the timer to emit the provided message after delay.

Creates an unattached instance of Delay.

Source

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

Available on crate feature unstable only.

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.

§Stability

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§

Source§

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

Source§

fn is_terminated(&self) -> bool

Returns true if the source has stopped producing messages.
Source§

fn terminate_by_ref(&self) -> bool

Terminates the source. Drop is called immediately. Read more
Source§

fn terminate(self) -> bool
where Self: Sized,

Terminates the source. Drop is called immediately. Read more

Auto Trait Implementations§

§

impl<M> Freeze for Delay<M>

§

impl<M> !RefUnwindSafe for Delay<M>

§

impl<M> Send for Delay<M>
where M: Send,

§

impl<M> Sync for Delay<M>
where M: Sync,

§

impl<M> !Unpin for Delay<M>

§

impl<M> UnsafeUnpin for Delay<M>

§

impl<M> !UnwindSafe for Delay<M>

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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