Struct RelationshipDef 

pub struct RelationshipDef {
    pub name: String,
    pub target: String,
    pub cardinality: Cardinality,
    pub navigation: NavigationHint,
    pub foreign_key: Option<String>,
    pub inverse: Option<String>,
    pub description: Option<String>,
}

A service-to-service relationship declaration.

Each service declares its own relationships independently. The inverse field is a documentation hint, not a hard reference. Relationships carry two dimensions: structural (cardinality) and presentational (navigation hint).

use ferro_projections::{RelationshipDef, Cardinality, NavigationHint};

let rel = RelationshipDef::new("customer", "customer", Cardinality::ManyToOne)
    .foreign_key("customer_id")
    .inverse("orders")
    .navigation(NavigationHint::Link)
    .description("Customer who placed this order");

Fields

name: String

Relationship name (e.g., “customer”, “line_items”).

target: String

Target service name (e.g., “customer”, “order_line_item”).

cardinality: Cardinality

Structural cardinality of the relationship.

navigation: NavigationHint

How the renderer should present this relationship.

foreign_key: Option<String>

Foreign key field name on the owning side.

inverse: Option<String>

Name of the inverse relationship on the target service.

description: Option<String>

Human-readable description of the relationship.

Implementations

impl RelationshipDef

pub fn new( name: impl Into<String>, target: impl Into<String>, cardinality: Cardinality, ) -> Self

Creates a new relationship definition with default navigation from cardinality.

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

Sets the foreign key field name.

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

Sets the inverse relationship name on the target service.

pub fn navigation(self, hint: NavigationHint) -> Self

Overrides the default navigation hint.

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

Sets the relationship description.

Trait Implementations

impl Clone for RelationshipDef

fn clone(&self) -> RelationshipDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationshipDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelationshipDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RelationshipDef

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 RelationshipDef

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

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 RelationshipDef

impl StructuralPartialEq for RelationshipDef