Enum Annotation 

#[non_exhaustive]
pub enum Annotation {
    AutoCreateTime,
    AutoUpdateTime,
    AutoIncrement,
    Choices(Vec<String>),
    DefaultValue(DefaultValue),
    Index(Option<IndexValue>),
    MaxLength(i32),
    NotNull,
    PrimaryKey,
    Unique,
    ForeignKey(ForeignKey),
}

The subset of annotations which need to be communicated with the migration tool

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AutoCreateTime

Only for DbType::Timestamp, DbType::DateTime, DbType::Time and DbType::Date. Will set the current time of the database when a row is created.

AutoUpdateTime

Only for DbType::Timestamp, DbType::DateTime, DbType::Time and DbType::Date. Will set the current time of the database when a row is updated.

AutoIncrement

AUTO_INCREMENT constraint

Choices(Vec<String>)

A list of choices to set

DefaultValue(DefaultValue)

DEFAULT constraint

Index(Option<IndexValue>)

Create an index. The optional IndexValue can be used, to build more complex indexes.

MaxLength(i32)

Only for VARCHAR, VARBINARY. Specifies the maximum length of the column’s content.

NotNull

NOT NULL constraint

PrimaryKey

The annotated column will be used as primary key

Unique

UNIQUE constraint

ForeignKey(ForeignKey)

Foreign Key constraint

Implementations

impl Annotation

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

Alternative shallow equals function.

Returns true on:

use rorm_declaration::imr::Annotation;

assert!(Annotation::MaxLength(0).eq_shallow(&Annotation::MaxLength(255)));

pub fn hash_shallow(&self) -> u64

Alternative shallow hash function.

Returns true on:

use rorm_declaration::imr::Annotation;

assert_eq!(Annotation::MaxLength(0).hash_shallow(), Annotation::MaxLength(255).hash_shallow());

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Annotation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for Annotation

type Iterator = AnnotationIter

fn iter() -> AnnotationIter

impl PartialEq for Annotation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Annotation

impl StructuralPartialEq for Annotation