Struct elfo::signal::Signal

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

A source that emits a message once a signal is received. Clones the message on every tick.

It’s based on the tokio implementation, so it should be useful to read about caveats.

Tracing

Every message starts a new trace, thus a new trace id is generated and assigned to the current scope.

Example

use elfo::signal::{Signal, SignalKind};

#[message]
struct ReloadFile;

ctx.attach(Signal::new(SignalKind::UnixHangup, ReloadFile));

while let Some(envelope) = ctx.recv().await {
    msg!(match envelope {
        ReloadFile => { /* ... */ },
    });
}

Implementations

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

pub fn new(kind: SignalKind, message: M) -> UnattachedSource<Signal<M>>

Creates an unattached instance of Signal.

pub fn set_message(&self, message: M)

Replaces a stored message with the provided one.

Trait Implementations

impl<M> SourceHandle for Signal<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.