Skip to main content

FieldDecl

Struct FieldDecl 

Source
pub struct FieldDecl {
    pub name: Ident,
    pub field_type: FieldType,
    pub modifier: FieldModifier,
    pub attributes: Vec<FieldAttribute>,
    pub span: Span,
}
Expand description

A field declaration within a model.

Fields§

§name: Ident

The field name.

§field_type: FieldType

The field type.

§modifier: FieldModifier

Optional or array modifier.

§attributes: Vec<FieldAttribute>

Field-level attributes (@id, @unique, etc.).

§span: Span

Span covering the entire field declaration.

Implementations§

Source§

impl FieldDecl

Source

pub fn is_optional(&self) -> bool

Checks if this field is optional (has ? modifier).

Examples found in repository?
examples/visitor_demo.rs (line 117)
116    fn visit_field(&mut self, field: &FieldDecl) -> Result<()> {
117        if field.is_optional() {
118            self.optional_fields += 1;
119        }
120        if field.is_array() {
121            self.array_fields += 1;
122        }
123
124        for attr in &field.attributes {
125            match attr {
126                FieldAttribute::Unique => self.unique_constraints += 1,
127                FieldAttribute::Relation { .. } => self.relations += 1,
128                _ => {}
129            }
130        }
131
132        Ok(())
133    }
134}
135
136#[derive(Default)]
137struct RelationshipGraph {
138    // model_name -> [(related_model, field_name, is_required)]
139    relationships: HashMap<String, Vec<(String, String, bool)>>,
140}
141
142impl Visitor for RelationshipGraph {
143    fn visit_model(&mut self, model: &ModelDecl) -> Result<()> {
144        let model_name = model.name.value.clone();
145
146        for field in &model.fields {
147            if let FieldType::UserType(related_type) = &field.field_type {
148                if field.has_relation_attribute() || field.is_array() {
149                    let is_required = !field.is_optional() && !field.is_array();
150
151                    self.relationships
152                        .entry(model_name.clone())
153                        .or_default()
154                        .push((related_type.clone(), field.name.value.clone(), is_required));
155                }
156            }
157        }
158
159        walk_model(self, model)
160    }
Source

pub fn is_not_null(&self) -> bool

Checks if this field has an explicit not-null modifier (!).

Source

pub fn is_array(&self) -> bool

Checks if this field is an array (has [] modifier).

Examples found in repository?
examples/visitor_demo.rs (line 120)
116    fn visit_field(&mut self, field: &FieldDecl) -> Result<()> {
117        if field.is_optional() {
118            self.optional_fields += 1;
119        }
120        if field.is_array() {
121            self.array_fields += 1;
122        }
123
124        for attr in &field.attributes {
125            match attr {
126                FieldAttribute::Unique => self.unique_constraints += 1,
127                FieldAttribute::Relation { .. } => self.relations += 1,
128                _ => {}
129            }
130        }
131
132        Ok(())
133    }
134}
135
136#[derive(Default)]
137struct RelationshipGraph {
138    // model_name -> [(related_model, field_name, is_required)]
139    relationships: HashMap<String, Vec<(String, String, bool)>>,
140}
141
142impl Visitor for RelationshipGraph {
143    fn visit_model(&mut self, model: &ModelDecl) -> Result<()> {
144        let model_name = model.name.value.clone();
145
146        for field in &model.fields {
147            if let FieldType::UserType(related_type) = &field.field_type {
148                if field.has_relation_attribute() || field.is_array() {
149                    let is_required = !field.is_optional() && !field.is_array();
150
151                    self.relationships
152                        .entry(model_name.clone())
153                        .or_default()
154                        .push((related_type.clone(), field.name.value.clone(), is_required));
155                }
156            }
157        }
158
159        walk_model(self, model)
160    }
Source

pub fn find_attribute(&self, kind: &str) -> Option<&FieldAttribute>

Finds a field attribute by kind.

Source

pub fn has_relation_attribute(&self) -> bool

Checks if this field has a @relation attribute.

Examples found in repository?
examples/visitor_demo.rs (line 148)
143    fn visit_model(&mut self, model: &ModelDecl) -> Result<()> {
144        let model_name = model.name.value.clone();
145
146        for field in &model.fields {
147            if let FieldType::UserType(related_type) = &field.field_type {
148                if field.has_relation_attribute() || field.is_array() {
149                    let is_required = !field.is_optional() && !field.is_array();
150
151                    self.relationships
152                        .entry(model_name.clone())
153                        .or_default()
154                        .push((related_type.clone(), field.name.value.clone(), is_required));
155                }
156            }
157        }
158
159        walk_model(self, model)
160    }
Source

pub fn column_name(&self) -> &str

Gets the physical column name from @map attribute, or the field name.

Trait Implementations§

Source§

impl Clone for FieldDecl

Source§

fn clone(&self) -> FieldDecl

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldDecl

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FieldDecl

Source§

fn eq(&self, other: &FieldDecl) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FieldDecl

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.