Struct DbField 

pub struct DbField {
    pub name: String,
    pub field_type: DbFieldType,
    pub required: bool,
    pub unique: bool,
    pub index: bool,
    pub returned: bool,
    pub input: bool,
    pub foreign_key: Option<ForeignKey>,
    pub generated_id: Option<IdGeneration>,
}

Field metadata used by adapters and migrations.

Fields

name: String

field_type: DbFieldType

required: bool

unique: bool

index: bool

returned: bool

input: bool

foreign_key: Option<ForeignKey>

generated_id: Option<IdGeneration>

Implementations

impl DbField

pub fn new(name: impl Into<String>, field_type: DbFieldType) -> DbField

Create a required, returned, input-accepted field.

pub fn optional(self) -> DbField

pub fn unique(self) -> DbField

pub fn indexed(self) -> DbField

pub fn hidden(self) -> DbField

pub fn generated(self) -> DbField

pub fn generated_id(self, generation: IdGeneration) -> DbField

pub fn references(self, foreign_key: ForeignKey) -> DbField

Trait Implementations

impl Clone for DbField

fn clone(&self) -> DbField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DbField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DbField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DbField

impl PartialEq for DbField

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

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 DbField