Struct GuardDef 

pub struct GuardDef {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
}

A named boolean condition that guards action execution or state transitions.

Guards are declarative checks referenced by name. The actual evaluation logic lives outside the projection schema.

use ferro_projections::GuardDef;

let guard = GuardDef::new("has_items")
    .display_name("Has Items")
    .description("Order must contain at least one line item");

Fields

name: String

display_name: Option<String>

description: Option<String>

Implementations

impl GuardDef

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

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

Trait Implementations

impl Clone for GuardDef

fn clone(&self) -> GuardDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuardDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GuardDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GuardDef

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 GuardDef

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

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 GuardDef

impl StructuralPartialEq for GuardDef