Struct Relation 

pub struct Relation {
    pub name: Option<SmolStr>,
    pub from_model: SmolStr,
    pub from_field: SmolStr,
    pub from_fields: Vec<SmolStr>,
    pub to_model: SmolStr,
    pub to_field: Option<SmolStr>,
    pub to_fields: Vec<SmolStr>,
    pub relation_type: RelationType,
    pub on_delete: Option<ReferentialAction>,
    pub on_update: Option<ReferentialAction>,
}

A resolved relation between two models.

Fields

name: Option<SmolStr>

Relation name (for disambiguation when multiple relations exist).

from_model: SmolStr

The model containing the foreign key.

from_field: SmolStr

The field on the from model.

from_fields: Vec<SmolStr>

The foreign key field(s) on the from model.

to_model: SmolStr

The model being referenced.

to_field: Option<SmolStr>

The field on the to model (back-relation).

to_fields: Vec<SmolStr>

The referenced field(s) on the to model.

relation_type: RelationType

The type of relation.

on_delete: Option<ReferentialAction>

On delete action.

on_update: Option<ReferentialAction>

On update action.

Implementations

impl Relation

pub fn new( from_model: impl Into<SmolStr>, from_field: impl Into<SmolStr>, to_model: impl Into<SmolStr>, relation_type: RelationType, ) -> Relation

Create a new relation.

pub fn with_name(self, name: impl Into<SmolStr>) -> Relation

Set the relation name.

pub fn with_from_fields(self, fields: Vec<SmolStr>) -> Relation

Set the foreign key fields.

pub fn with_to_fields(self, fields: Vec<SmolStr>) -> Relation

Set the referenced fields.

pub fn with_to_field(self, field: impl Into<SmolStr>) -> Relation

Set the back-relation field.

pub fn with_on_delete(self, action: ReferentialAction) -> Relation

Set the on delete action.

pub fn with_on_update(self, action: ReferentialAction) -> Relation

Set the on update action.

pub fn is_implicit_many_to_many(&self) -> bool

Check if this is an implicit many-to-many relation.

pub fn join_table_name(&self) -> Option<String>

Get the join table name for many-to-many relations.

Trait Implementations

impl Clone for Relation

fn clone(&self) -> Relation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Relation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Relation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Relation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Relation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Relation