Struct ForeignKey 

pub struct ForeignKey<T: Table> {
    pub field: &'static str,
    pub sql: &'static str,
    /* private fields */
}

Represents a foreign key column, establishing a relationship to another table.

Fields

field: &'static str

The rust field name of the model

sql: &'static str

The associated sql column name

Implementations

impl<T: Table> ForeignKey<T>

pub const fn new(field: &'static str, sql: &'static str) -> Self

pub const fn as_col(&'static self) -> Column<T>

pub const unsafe fn transmute<I: Table>(&'static self) -> &'static ForeignKey<I>

Safety

We do treat this foreign key as a column of another table. This is not smart to do - but can become necessary when doing complex joins. This is memory safe as Self<A> and Self<B> have the exact same memory layout, we do not store any data (A or B) but only a PhantomData instance which is here transmuted.

Trait Implementations

impl<T: Table> Clone for ForeignKey<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Table> Debug for ForeignKey<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Table> PartialEq for ForeignKey<T>

fn eq(&self, other: &ForeignKey<T>) -> 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<T: Copy + Table> Copy for ForeignKey<T>

impl<T: Eq + Table> Eq for ForeignKey<T>

impl<T: Table> StructuralPartialEq for ForeignKey<T>