Struct RelationshipDefinition 

pub struct RelationshipDefinition {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub inverse: Option<String>,
    pub symmetric: bool,
    pub cardinality: Cardinality,
    pub source_types: Vec<String>,
    pub target_types: Vec<String>,
    pub built_in: bool,
    pub color: Option<String>,
    pub icon: Option<String>,
}

Defines a relationship type and its constraints

Fields

name: String

Unique identifier for this relationship type (lowercase, no spaces)

display_name: String

Human-readable display name

description: String

Description of what this relationship means

inverse: Option<String>

The inverse relationship name (if any) e.g., “parent” has inverse “child”

symmetric: bool

Whether this relationship is symmetric (A->B implies B->A with same type) e.g., “duplicate” is symmetric

cardinality: Cardinality

Cardinality constraints

source_types: Vec<String>

Source type constraints (which requirement types can be the source) Empty means all types allowed

target_types: Vec<String>

Target type constraints (which requirement types can be the target) Empty means all types allowed

built_in: bool

Whether this is a built-in relationship (cannot be deleted)

color: Option<String>

Color for visualization (optional, hex format e.g., “#ff6b6b”)

icon: Option<String>

Icon/symbol for the relationship (optional)

Implementations

impl RelationshipDefinition

pub fn new(name: &str, display_name: &str) -> Self

Create a new relationship definition

pub fn built_in(name: &str, display_name: &str, description: &str) -> Self

Create a built-in relationship definition

pub fn with_inverse(self, inverse: &str) -> Self

Set the inverse relationship

pub fn with_symmetric(self, symmetric: bool) -> Self

Set as symmetric

pub fn with_cardinality(self, cardinality: Cardinality) -> Self

Set the cardinality

pub fn with_source_types(self, types: Vec<String>) -> Self

Set source type constraints

pub fn with_target_types(self, types: Vec<String>) -> Self

Set target type constraints

pub fn with_color(self, color: &str) -> Self

Set the color

pub fn defaults() -> Vec<RelationshipDefinition>

Get the default built-in relationship definitions

pub fn allows_source_type(&self, req_type: &RequirementType) -> bool

Check if a source requirement type is allowed

pub fn allows_target_type(&self, req_type: &RequirementType) -> bool

Check if a target requirement type is allowed

Trait Implementations

impl Clone for RelationshipDefinition

fn clone(&self) -> RelationshipDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationshipDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelationshipDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RelationshipDefinition

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for RelationshipDefinition

type WithoutGenerics = RelationshipDefinition

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = RelationshipDefinition

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Eq for RelationshipDefinition

impl StructuralPartialEq for RelationshipDefinition