Struct ActionDef 

pub struct ActionDef {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub inputs: Vec<InputDef>,
    pub preconditions: Vec<String>,
    pub effects: Vec<String>,
    pub transition_trigger: Option<String>,
}

A business operation schema describing what an action does and what it needs.

Actions are the verbs of a service: “submit order”, “approve review”, “send invoice”. Each action defines its input contract, preconditions that must hold, effects that will occur, and an optional link to a state machine transition.

use ferro_projections::{ActionDef, InputDef, DataType, FieldMeaning};

let action = ActionDef::new("submit_order")
    .display_name("Submit Order")
    .description("Validates and submits a customer order for processing")
    .input(InputDef::new("order_id", DataType::Integer, FieldMeaning::Identifier))
    .precondition("has_items")
    .precondition("payment_valid")
    .effect("notify_customer")
    .transition_trigger("submit");

Fields

name: String

display_name: Option<String>

description: Option<String>

inputs: Vec<InputDef>

preconditions: Vec<String>

effects: Vec<String>

transition_trigger: Option<String>

Implementations

impl ActionDef

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

Creates a new action definition with the given name.

pub fn display_name(self, name: impl Into<String>) -> Self

Sets the human-readable display name.

pub fn description(self, desc: impl Into<String>) -> Self

Sets the action description.

pub fn input(self, input: InputDef) -> Self

Adds an input parameter to this action.

pub fn precondition(self, guard: impl Into<String>) -> Self

Adds a precondition guard name that must hold before this action can execute.

pub fn effect(self, effect: impl Into<String>) -> Self

Adds an effect name that occurs when this action executes.

pub fn transition_trigger(self, trigger: impl Into<String>) -> Self

Sets the state machine transition that this action triggers.

Trait Implementations

impl Clone for ActionDef

fn clone(&self) -> ActionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ActionDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ActionDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ActionDef

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ActionDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ActionDef

impl StructuralPartialEq for ActionDef