Struct CausalAction 

pub struct CausalAction { /* private fields */ }

A CausalAction represents an executable action that can be triggered in response to causal conditions.

In a causal state machine (CSM), actions are paired with causal states. When a causal state’s conditions are met (evaluated to true), the associated action is fired.

Purpose

CausalAction encapsulates a function that performs a specific task, such as:

• Triggering alerts or alarms
• Logging events
• Sending notifications
• Executing control operations

Usage

CausalAction is typically used in conjunction with CausalState in a state-action pair within a causal state machine (CSM). The CSM evaluates states and, when conditions are met, fires the associated actions.

Example

use deep_causality::{ActionError, CausalAction};

fn get_alert_action() -> CausalAction {
    let func = || {
        println!("Alert triggered!");
        Ok(())
    };
    let descr = "Action that triggers an alert";
    let version = 1;

    CausalAction::new(func, descr, version)
}

Implementations

impl CausalAction

pub fn fire(&self) -> Result<(), ActionError>

Executes the action function encapsulated by this CausalAction.

This method is typically called by a causal state machine (CSM) when the associated causal state’s conditions are met.

Returns

• Ok(()) if the action executes successfully
• Err(ActionError) if the action fails

Example

use deep_causality::{ActionError, CausalAction};

// Create a CausalAction
let action = CausalAction::new(
    || { println!("Action executed!"); Ok(()) },
    "Example action",
    1
);

// Fire the action
match action.fire() {
    Ok(()) => println!("Action completed successfully"),
    Err(e) => println!("Action failed: {}", e),
}

impl CausalAction

pub fn action(&self) -> fn() -> Result<(), ActionError>

pub fn description(&self) -> &'static str

pub fn version(&self) -> usize

impl CausalAction

pub fn new( action: fn() -> Result<(), ActionError>, description: &'static str, version: usize, ) -> Self

Trait Implementations

impl Clone for CausalAction

fn clone(&self) -> CausalAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CausalAction

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

Formats the value using the given formatter.

impl Display for CausalAction

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

Formats the value using the given formatter.