Struct geekorm::ForeignKey

pub struct ForeignKey<T, D>
where
    T: Display + 'static,
    D: TableBuilder,
{
    pub key: T,
    pub data: D,
}

Foreign Key Type

use geekorm::prelude::*;
use geekorm::{ForeignKey, PrimaryKeyInteger};

#[derive(Clone, Default, GeekTable)]
struct Users {
    id: PrimaryKeyInteger,
    name: String,
}

#[derive(Default, Clone, GeekTable)]
struct Posts {
    id: PrimaryKeyInteger,
    title: String,
    /// Foreign Key to the Users table
    /// i32 as the key type, and Users as the data type
    #[geekorm(foreign_key = "Users.id")]
    user: ForeignKey<i32, Users>,
}

// Create the Posts table with the foreign key referencing the Users table (Users.id)
let create_posts_query = Posts::create().build()
    .expect("Failed to build query");

// Use the foreign key to and join the tables together
// to get the user posts
let user_posts = Users::select()
    .order_by("name", geekorm::QueryOrder::Asc)
    .build()
    .expect("Failed to build query");

println!("User posts query: {:?}", user_posts);
// ...

Fields

key: T

Foreign Key Value

data: D

Foreign Key Data Type

Implementations

impl<D> ForeignKey<i32, D>

where D: TableBuilder + Default,

pub fn new(value: i32) -> ForeignKey<i32, D>

Create a new foreign key with an integer

impl<D> ForeignKey<String, D>

where D: TableBuilder + Default,

pub fn new(value: String) -> ForeignKey<String, D>

Create a new foreign key with a String

Trait Implementations

impl<T, D> Clone for ForeignKey<T, D>

where T: Clone + Display + 'static, D: Clone + TableBuilder,

fn clone(&self) -> ForeignKey<T, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, D> Debug for ForeignKey<T, D>

where T: Debug + Display + 'static, D: TableBuilder,

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

Formats the value using the given formatter.

impl<D> Default for ForeignKey<String, D>

where D: TableBuilder + Default,

fn default() -> ForeignKey<String, D>

Returns the “default value” for a type.

impl<D> Default for ForeignKey<i32, D>

where D: TableBuilder + Default,

fn default() -> ForeignKey<i32, D>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for ForeignKey<i32, T>

where T: TableBuilder + Default + Serialize + Deserialize<'de>,

fn deserialize<D>( deserializer: D ) -> Result<ForeignKey<i32, T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, D> Display for ForeignKey<T, D>

where T: Display + 'static, D: TableBuilder,

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

Formats the value using the given formatter.

impl<T> From<&ForeignKey<i32, T>> for Value

where T: TableBuilder + TablePrimaryKey,

fn from(value: &ForeignKey<i32, T>) -> Value

Converts to this type from the input type.

impl<D> From<&str> for ForeignKey<String, D>

where D: TableBuilder + Default,

fn from(value: &str) -> ForeignKey<String, D>

Converts to this type from the input type.

impl<T> From<ForeignKey<i32, T>> for Value

where T: TableBuilder + TablePrimaryKey,

fn from(value: ForeignKey<i32, T>) -> Value

Converts to this type from the input type.

impl<D> From<PrimaryKey<String>> for ForeignKey<String, D>

where D: TableBuilder + Default,

fn from(value: PrimaryKey<String>) -> ForeignKey<String, D>

Converts to this type from the input type.

impl<D> From<PrimaryKey<i32>> for ForeignKey<i32, D>

where D: TableBuilder + Default,

fn from(value: PrimaryKey<i32>) -> ForeignKey<i32, D>

Converts to this type from the input type.

impl<D> From<String> for ForeignKey<String, D>

where D: TableBuilder + Default,

fn from(value: String) -> ForeignKey<String, D>

Converts to this type from the input type.

impl<D> From<i32> for ForeignKey<i32, D>

where D: TableBuilder + Default,

fn from(value: i32) -> ForeignKey<i32, D>

Converts to this type from the input type.

impl<T, D> PartialEq for ForeignKey<T, D>

where T: PartialEq + Display + 'static, D: PartialEq + TableBuilder,

fn eq(&self, other: &ForeignKey<T, D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D> Serialize for ForeignKey<i32, D>

where D: TableBuilder + Default,

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<T, D> Copy for ForeignKey<T, D>

where T: Copy + Display + 'static, D: Copy + TableBuilder,

impl<T, D> Eq for ForeignKey<T, D>

where T: Eq + Display + 'static, D: Eq + TableBuilder,

impl<T, D> StructuralPartialEq for ForeignKey<T, D>

where T: Display + 'static, D: TableBuilder,