Struct ServiceDef 

pub struct ServiceDef {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub fields: Vec<FieldDef>,
    pub actions: Vec<ActionDef>,
    pub guards: Vec<GuardDef>,
    pub relationships: Vec<RelationshipDef>,
    pub intent_hints: Vec<IntentHint>,
    pub state_machine: Option<StateMachine>,
}

A service definition describing a domain entity and its fields.

Constructed via a builder API with method chaining:

use ferro_projections::{ServiceDef, DataType, FieldMeaning};

let order = ServiceDef::new("order")
    .display_name("Order")
    .description("Manages customer orders")
    .field("id", DataType::Integer, FieldMeaning::Identifier)
    .field("total", DataType::Float, FieldMeaning::Money)
    .optional_field("notes", DataType::String, FieldMeaning::FreeText);

Fields

name: String

display_name: Option<String>

description: Option<String>

fields: Vec<FieldDef>

actions: Vec<ActionDef>

guards: Vec<GuardDef>

relationships: Vec<RelationshipDef>

intent_hints: Vec<IntentHint>

state_machine: Option<StateMachine>

Implementations

impl ServiceDef

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

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

pub fn field( self, name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Adds a required read-write field.

pub fn optional_field( self, name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Adds an optional (nullable) read-write field.

pub fn list_field( self, name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Adds a required read-write list field.

pub fn read_only_field( self, name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Adds a required read-only field (readable but not writable).

For system-assigned or computed fields like id, created_at, or totals.

pub fn write_only_field( self, name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Adds a required write-only field (writable but not readable).

For sensitive inputs like passwords or API keys that should not be read back.

pub fn action(self, action: ActionDef) -> Self

Adds an action definition to this service.

pub fn guard(self, guard: GuardDef) -> Self

Adds a guard definition to this service.

pub fn relationship(self, rel: RelationshipDef) -> Self

Adds a relationship definition to this service.

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

Adds a many-to-one relationship (this service belongs to target).

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

Adds a one-to-many relationship (this service has many of target).

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

Adds a one-to-one relationship (this service has one of target).

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

Adds a many-to-many relationship (this service belongs to many of target).

pub fn intent_hint(self, hint: IntentHint) -> Self

Adds an intent hint for overriding structural derivation.

pub fn state_machine(self, machine: StateMachine) -> Self

Sets the state machine definition for this service.

pub fn from_model(meta: &ModelMetadata) -> Self

Derives a ServiceDef from model metadata.

Infers DataType from column type strings and FieldMeaning from field names. System fields (id, created_at, updated_at, primary keys) are marked read-only. Actions, state machines, and relationships are not derived.

pub fn validate(&self) -> Result<Vec<Warning>, Error>

Validates the service definition and returns warnings for potential issues.

This is the single validation entry point that subsumes StateMachine::validate(). Guard names form a shared pool referenced from transitions and action preconditions.

Returns Err for fatal issues (undefined guard references, unmatched triggers). Returns Ok(warnings) for structural concerns (unused guards, missing state machine).

Trait Implementations

impl Clone for ServiceDef

fn clone(&self) -> ServiceDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ServiceDef

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 ServiceDef

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

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 ServiceDef