Struct parser_database::walkers::InlineRelationWalker

pub struct InlineRelationWalker<'db>(/* private fields */);

An explicitly defined 1:1 or 1:n relation. The walker has the referencing side defined, but might miss the back relation in the AST.

Implementations

impl<'db> InlineRelationWalker<'db>

pub fn is_one_to_one(self) -> bool

The relation is 1:1, having at most one record on both sides of the relation.

pub fn referencing_model(self) -> ModelWalker<'db>

The model which holds the relation arguments.

pub fn referenced_model(self) -> ModelWalker<'db>

The model referenced and which hold the back-relation field.

pub fn as_complete(self) -> Option<CompleteInlineRelationWalker<'db>>

If the relation is defined from both sides, convert to an explicit relation walker.

pub fn referencing_fields( self ) -> Option<impl ExactSizeIterator<Item = ScalarFieldWalker<'db>>>

The referencing fields, from the forward relation field.

pub fn referenced_fields( self ) -> Box<dyn Iterator<Item = ScalarFieldWalker<'db>> + 'db>

The referenced fields. Inferred or specified.

pub fn forward_relation_field(self) -> Option<RelationFieldWalker<'db>>

The forward relation field (the relation field on model A, the referencing model).

pub fn mapped_name(self) -> Option<&'db str>

The contents of the map: ... argument of the @relation attribute.

pub fn back_relation_field(self) -> Option<RelationFieldWalker<'db>>

The back relation field, or virtual relation field (on model B, the referenced model).

pub fn relation_id(self) -> RelationId

The unique identifier of the relation.

pub fn explicit_relation_name(self) -> Option<&'db str>

The relation name in the schema.

myField OtherModel @relation("thisModelToOtherModel", fields: [fkfield], references: [id])
//                           ^^^^^^^^^^^^^^^^^^^^^^^

pub fn relation_name(self) -> RelationName<'db>

The name of the relation. Either uses the name (or default) argument, or generates an implicit name.

Trait Implementations

impl<'db> Clone for InlineRelationWalker<'db>

fn clone(&self) -> InlineRelationWalker<'db>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'db> Copy for InlineRelationWalker<'db>