Struct Signal 

pub struct Signal {
    pub id: String,
    pub metadata: HashMap<String, String>,
}

Available on crate feature signals only.

A signal emitted through the arbiter.

Signals are identified by an arbitrary string and can carry a map of metadata. Callers are free to define their own conventions for ids and fields.

Fields

id: String

Identifier of the signal, for example “request.started” or “metrics.tick”.

metadata: HashMap<String, String>

Optional metadata payload carried with the signal.

Implementations

impl Signal

pub fn new(id: impl Into<String>) -> Self

Creates a new signal with the given id and empty metadata.

pub fn with_metadata( id: impl Into<String>, metadata: HashMap<String, String>, ) -> Self

Creates a new signal with initial metadata.

pub fn from_payload<P: SignalPayload>(payload: &P) -> Self

Creates a signal from a typed payload implementing SignalPayload.

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signal

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

Formats the value using the given formatter.

impl Default for Signal

fn default() -> Signal

Returns the “default value” for a type.