Struct FieldDef 

pub struct FieldDef {
    pub name: String,
    pub kind: FieldKind,
    pub required: bool,
    pub unique: bool,
    pub indexed: bool,
    pub default: Option<Value>,
}

One declared column.

Fields

name: String

Lowercase snake-case identifier, unique within the table.

kind: FieldKind

required: bool

NOT NULL in the generated DDL. A required field with a default may still be left out of a write: the database supplies the value.

unique: bool

UNIQUE in the generated DDL. Uniqueness is enforced by the database, never by the row validator, because it reads other rows.

indexed: bool

Gets its own CREATE INDEX.

default: Option<Value>

Literal default, checked against kind by Schema::validate.

Implementations

impl FieldDef

pub fn new(name: impl Into<String>, kind: FieldKind) -> Self

An optional field of kind, with no default and no index.

pub fn required(self) -> Self

pub fn unique(self) -> Self

pub fn indexed(self) -> Self

pub fn default_value(self, value: Value) -> Self

pub fn must_be_present(&self) -> bool

Whether a write must carry this field. A default satisfies required, so only a required field without one has to be sent.

Trait Implementations

impl Clone for FieldDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldDef

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FieldDef

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldDef