Struct Signal 

pub struct Signal {
    pub kind: SignalKind,
    pub scope: SignalScope,
    pub source: Principal,
}

A control signal message.

Signals are used for immediate control operations like stopping or canceling work in progress.

Permission Checking

The signal itself does not contain permission information. Permission is determined by:

1. The runtime layer’s Session that sends the signal
2. The SignalScope being targeted
3. The policy configured in the EventBus

Why No Default?

DO NOT implement Default for Signal.

A signal requires:

• A valid SignalKind
• A valid SignalScope
• A valid Principal (who is sending)

There is no sensible default for any of these.

Example

use orcs_event::{Signal, SignalKind};
use orcs_types::{Principal, ChannelId, PrincipalId, SignalScope};

let principal = Principal::User(PrincipalId::new());
let channel = ChannelId::new();

let signal = Signal::new(
    SignalKind::Cancel,
    SignalScope::Channel(channel),
    principal,
);

Fields

kind: SignalKind

What type of signal.

scope: SignalScope

What scope is affected.

source: Principal

Who is sending the signal.

Implementations

impl Signal

pub fn new(kind: SignalKind, scope: SignalScope, source: Principal) -> Signal

Creates a new signal.

Arguments

• kind - The type of signal
• scope - What scope is affected
• source - Who is sending the signal

Note

This does not check permissions. Permission checking is done at the EventBus layer using the Session’s privilege.

pub fn veto(source: Principal) -> Signal

Creates a Veto (global stop) signal.

Requires elevated privilege to execute.

Arguments

• source - Who is sending the signal

Example

use orcs_event::Signal;
use orcs_types::{Principal, PrincipalId};

let principal = Principal::User(PrincipalId::new());
let signal = Signal::veto(principal);

assert!(signal.is_veto());
assert!(signal.is_global());

pub fn cancel(channel: ChannelId, source: Principal) -> Signal

Creates a Cancel signal for a specific channel.

Arguments

• channel - The channel to cancel
• source - Who is sending the signal

Example

use orcs_event::Signal;
use orcs_types::{Principal, ChannelId, PrincipalId};

let principal = Principal::User(PrincipalId::new());
let channel = ChannelId::new();
let signal = Signal::cancel(channel, principal);

assert!(!signal.is_veto());
assert!(signal.affects_channel(channel));

pub fn is_veto(&self) -> bool

Returns true if this is a Veto signal.

pub fn is_global(&self) -> bool

Returns true if this signal has Global scope.

pub fn affects_channel(&self, channel: ChannelId) -> bool

Returns true if this signal affects the given channel.

Global signals affect all channels.

pub fn pause(channel: ChannelId, source: Principal) -> Signal

Creates a Pause signal for a specific channel.

Arguments

• channel - The channel to pause
• source - Who is sending the signal

pub fn resume(channel: ChannelId, source: Principal) -> Signal

Creates a Resume signal for a specific channel.

Arguments

• channel - The channel to resume
• source - Who is sending the signal

pub fn steer( channel: ChannelId, message: impl Into<String>, source: Principal, ) -> Signal

Creates a Steer signal for a specific channel.

Arguments

• channel - The channel to steer
• message - Instruction for how to change direction
• source - Who is sending the signal

pub fn approve(approval_id: impl Into<String>, source: Principal) -> Signal

Creates an Approve signal for a pending HIL request.

Arguments

• approval_id - ID of the approval request to approve
• source - Who is sending the signal (typically Human)

pub fn reject( approval_id: impl Into<String>, reason: Option<String>, source: Principal, ) -> Signal

Creates a Reject signal for a pending HIL request.

Arguments

• approval_id - ID of the approval request to reject
• reason - Optional reason for rejection
• source - Who is sending the signal (typically Human)

pub fn is_pause(&self) -> bool

Returns true if this is a Pause signal.

pub fn is_resume(&self) -> bool

Returns true if this is a Resume signal.

pub fn is_approve(&self) -> bool

Returns true if this is an Approve signal.

pub fn is_reject(&self) -> bool

Returns true if this is a Reject signal.

pub fn is_modify(&self) -> bool

Returns true if this is a Modify signal.

pub fn is_hil_response(&self) -> bool

Returns true if this is a HIL response signal (Approve, Reject, or Modify).

pub fn modify( approval_id: impl Into<String>, modified_payload: Value, source: Principal, ) -> Signal

Creates a Modify signal for a pending HIL request.

Approves the request but with modified parameters.

Arguments

• approval_id - ID of the approval request to modify
• modified_payload - Modified payload to use instead of original
• source - Who is sending the signal (typically Human)

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signal

fn deserialize<__D>( __deserializer: __D, ) -> Result<Signal, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Signal

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.