Struct StateDef 

pub struct StateDef {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub is_final: bool,
    pub on_enter: Vec<String>,
    pub on_exit: Vec<String>,
    pub metadata: Option<Value>,
}

A state within a state machine.

States can declare entry/exit side effects as string references and carry optional metadata for rendering hints.

Fields

name: String

State identifier (e.g., “draft”, “pending”, “completed”).

display_name: Option<String>

Human-readable name (e.g., “Pending Review”).

description: Option<String>

Description of what this state means.

is_final: bool

Whether this is a terminal state.

on_enter: Vec<String>

Side effects triggered on entering this state (string references).

on_exit: Vec<String>

Side effects triggered on exiting this state (string references).

metadata: Option<Value>

Arbitrary metadata for rendering hints.

Implementations

impl StateDef

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

Creates a new state 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 description.

pub fn final_state(self) -> Self

Marks this state as a terminal (final) state.

pub fn on_enter(self, effects: Vec<impl Into<String>>) -> Self

Sets the entry side effects (string references).

pub fn on_exit(self, effects: Vec<impl Into<String>>) -> Self

Sets the exit side effects (string references).

pub fn metadata(self, metadata: Value) -> Self

Sets arbitrary metadata for rendering hints.

Trait Implementations

impl Clone for StateDef

fn clone(&self) -> StateDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StateDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StateDef

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 StateDef

fn eq(&self, other: &StateDef) -> 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 StateDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateDef