Struct SentSignals 

pub struct SentSignals { /* private fields */ }

The signals a workflow may send with WorkflowContext::send_signal.

Built from the signal types themselves, never from hand-written names. It keeps a workflow from sending, by mistake, a signal that is not its own; it is not a security boundary: code running in a worker can reach the store and the internal API anyway.

Examples

use ironflow_engine::signal::{SentSignals, Signal};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, JsonSchema)]
struct HumanReplied {
    body: String,
}

impl Signal for HumanReplied {
    const NAME: &'static str = "gitlab.human_replied";
}

let sent = SentSignals::new().allow::<HumanReplied>();
assert!(sent.allows(HumanReplied::NAME));
assert!(!sent.allows("ci.pipeline_finished"));

Implementations

impl SentSignals

pub fn new() -> Self

An empty declaration: no signal may be sent.

Examples

use ironflow_engine::signal::SentSignals;

assert!(SentSignals::new().names().is_empty());

pub fn allow<S: Signal>(self) -> Self

Allow sending S.

Examples

use ironflow_engine::signal::{SentSignals, Signal};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, JsonSchema)]
struct Deployed {
    version: String,
}

impl Signal for Deployed {
    const NAME: &'static str = "deploy.done";
}

let sent = SentSignals::new().allow::<Deployed>().allow::<Deployed>();
assert_eq!(sent.names(), ["deploy.done"]);

pub fn allows(&self, name: &str) -> bool

Whether the signal named name may be sent.

Examples

use ironflow_engine::signal::SentSignals;

assert!(!SentSignals::new().allows("deploy.done"));

pub fn names(&self) -> &[&'static str]

Names of the allowed signals, in declaration order.

Examples

use ironflow_engine::signal::SentSignals;

let empty: &[&str] = &[];
assert_eq!(SentSignals::new().names(), empty);

Trait Implementations

impl Clone for SentSignals

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SentSignals

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

Formats the value using the given formatter.

impl Default for SentSignals

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SentSignals

impl PartialEq for SentSignals

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SentSignals