Enum Identity 

pub enum Identity {
    Unary(DynIden),
    Binary(DynIden, DynIden),
    Ternary(DynIden, DynIden, DynIden),
    Many(Vec<DynIden>),
}

A one-or-many column identifier — the abstraction SeaORM uses to refer to either a single column or a composite (e.g. a composite primary key or foreign key).

Specialized variants exist for the common arities (1/2/3 columns) to avoid heap allocation; longer composites fall back to Identity::Many.

Variants

Unary(DynIden)

A single column.

Binary(DynIden, DynIden)

Two columns (composite).

Ternary(DynIden, DynIden, DynIden)

Three columns (composite).

Many(Vec<DynIden>)

Four or more columns (composite).

Implementations

impl Identity

pub fn arity(&self) -> usize

Number of columns in this identifier.

pub fn iter(&self) -> BorrowedIdentityIter<'_>

Iterate over each column iden in order.

pub fn contains(&self, col: &DynIden) -> bool

true if col is one of the columns making up this identifier.

pub fn fully_contains(&self, other: &Identity) -> bool

true if every column of other also appears in self.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl Eq for Identity

impl Hash for Identity

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 Iden for Identity

fn quoted(&self) -> Cow<'static, str>

Return the to-be sanitized version of the identifier.

fn to_string(&self) -> String

A shortcut for writing an unquoted identifier into a String.

fn unquoted(&self) -> &str

Write a raw identifier string without quotes.

impl IntoIdentity for Identity

fn into_identity(self) -> Identity

Build the Identity.

impl IntoIterator for Identity

type Item = DynIden

The type of the elements being iterated over.

type IntoIter = OwnedIdentityIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Identity

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