Struct datamodel_renderer::datamodel::Field

pub struct Field<'a> { /* private fields */ }

A field in a model block.

Implementations

impl<'a> Field<'a>

pub fn new( name: impl Into<Cow<'a, str>>, type_name: impl Into<Cow<'a, str>> ) -> Self

Create a new required model field declaration.

model User {
  name String
//     ^^^^^^ type_name
//^^^^ name
}

pub fn optional(&mut self)

Sets the field as optional.

model Address {
  street String?
//             ^ this
}

pub fn array(&mut self)

Sets the field to be an array.

model Address {
  street String[]
//             ^^ this
}

pub fn unsupported(&mut self)

Sets the field to be unsupported.

model Address {
  street Unsupported("foo")
//       ^^^^^^^^^^^^^^^^^^ this
}

pub fn map(&mut self, value: impl Into<Cow<'a, str>>)

Sets the field map attribute.

model Address {
  street String @map("Straße")
                      ^^^^^^ value
}

pub fn documentation(&mut self, documentation: impl Into<Cow<'a, str>>)

Documentation of the field.

model Foo {
  /// This is the documentation.
  bar Int
}

pub fn default(&mut self, value: DefaultValue<'a>)

Sets the field default attribute.

model Address {
  street String @default("Prenzlauer Allee")
                          ^^^^^^^^^^^^^^^^ value
}

pub fn native_type( &mut self, prefix: impl Into<Cow<'a, str>>, type: impl Into<Cow<'a, str>>, params: Vec<String> )

Sets the native type of the field.

model Address {
  street String @db.VarChar(255)
//                          ^^^ param
//                  ^^^^^^^ type_name
//               ^^ prefix
}

TODO: params as &[&str] when we get rid of the DML.

pub fn updated_at(&mut self)

Marks the field to hold the update timestamp.

model Address {
  street String @updatedAt
//              ^^^^^^^^^^ adds this
}

pub fn unique(&mut self, options: UniqueFieldAttribute<'a>)

Marks the field to hold a unique constraint.

model Address {
  street String @unique(sort: Asc, length: 11)
//              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this
}

pub fn id(&mut self, definition: IdFieldDefinition<'a>)

Marks the field to be the id of the model.

model Address {
  street String @id
//              ^^^ this
}

pub fn relation(&mut self, relation: Relation<'a>)

Set the field to be a relation.

model Address {
  street Street @relation(...)
//              ^^^^^^^^^^^^^^ this
}

pub fn ignore(&mut self)

Ignores the field.

model Address {
  street Street @ignore
//              ^^^^^^^ this
}

pub fn commented_out(&mut self)

Comments the field out.

Trait Implementations

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Field<'a>

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

Formats the value using the given formatter.