geekorm_core::builder::keys::primary

Struct PrimaryKey

pub struct PrimaryKey<T>where
    T: Serialize + 'static,
{ /* private fields */ }

Expand description

§Primary Key

The Primary Key is a column in a Table used to uniquely identify a row.

In GeekORM, it can be an u64 (default), a String, or a Uuid.

§Standard Example

Here is an example of how to use the PrimaryKey.

use geekorm::prelude::*;

#[derive(Table, Clone, Default, serde::Serialize, serde::Deserialize)]
pub struct Users {
    #[geekorm(primary_key, auto_increment)]
    pub id: PrimaryKey<u64>,
    #[geekorm(unique)]
    pub username: String,
}

let user = Users {
    id: PrimaryKey::from(1),
    username: String::from("JohnDoe")
};

Implementations§

impl<T> PrimaryKey<T>
where T: Serialize + 'static,

pub fn value(&self) -> &T

Get the Primary Key value

impl PrimaryKey<u64>

pub fn new(value: u64) -> Self

Create a new primary key with an integer

impl PrimaryKey<String>

pub fn new(value: String) -> Self

Create a new primary key with a String

impl PrimaryKey<Uuid>

pub fn new(value: Uuid) -> Self

Create a new primary key with a Uuid

Trait Implementations§

impl<T> Clone for PrimaryKey<T>
where T: Serialize + 'static + Clone,

fn clone(&self) -> PrimaryKey<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for PrimaryKey<T>
where T: Serialize + Debug + 'static,

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

Formats the value using the given formatter. Read more

impl Default for PrimaryKey<i32>

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for PrimaryKey<String>

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

Deserialize this value from the given Serde deserializer. Read more

impl<'de> Deserialize<'de> for PrimaryKey<Uuid>

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

Deserialize this value from the given Serde deserializer. Read more

impl<'de> Deserialize<'de> for PrimaryKey<i32>

For backwards compatibility

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

Deserialize this value from the given Serde deserializer. Read more

impl<T> Display for PrimaryKey<T>
where T: Serialize + Display + 'static,

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

Formats the value using the given formatter. Read more

impl From<&PrimaryKey<String>> for Value

fn from(value: &PrimaryKey<String>) -> Self

Converts to this type from the input type.

impl From<&PrimaryKey<Uuid>> for Value

fn from(value: &PrimaryKeyUuid) -> Self

Converts to this type from the input type.

impl From<&PrimaryKey<i32>> for Value

fn from(value: &PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl From<&PrimaryKey<i32>> for i32

fn from(value: &PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl From<&PrimaryKey<i32>> for u64

fn from(value: &PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl From<&PrimaryKey<u64>> for Value

fn from(value: &PrimaryKeyInteger) -> Self

Converts to this type from the input type.

impl From<&String> for PrimaryKey<String>

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for PrimaryKey<String>

fn from(value: &str) -> Self

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>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<String>> for String

fn from(value: PrimaryKey<String>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<String>> for Value

fn from(value: PrimaryKey<String>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<Uuid>> for Value

fn from(value: PrimaryKeyUuid) -> Self

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>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<i32>> for Value

fn from(value: PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<i32>> for i32

fn from(value: PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<i32>> for u64

fn from(value: PrimaryKey<i32>) -> Self

Converts to this type from the input type.

impl<D> From<PrimaryKey<u64>> for ForeignKey<u64, D>
where D: TableBuilder + Default,

fn from(value: PrimaryKey<u64>) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<u64>> for Value

fn from(value: PrimaryKeyInteger) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<u64>> for i32

This is to make sure we are backwards compatible

fn from(value: PrimaryKeyInteger) -> Self

Converts to this type from the input type.

impl From<PrimaryKey<u64>> for u64

fn from(value: PrimaryKeyInteger) -> Self

Converts to this type from the input type.

impl From<String> for PrimaryKey<String>

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<i32> for PrimaryKey<i32>

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<u32> for PrimaryKey<i32>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<T> PartialEq for PrimaryKey<T>
where T: Serialize + 'static + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 PrimaryKey<String>

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

Serialize this value into the given Serde serializer. Read more

impl Serialize for PrimaryKey<Uuid>

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

Serialize this value into the given Serde serializer. Read more

impl Serialize for PrimaryKey<i32>

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

Serialize this value into the given Serde serializer. Read more

impl ToSqlite for PrimaryKey<String>

fn on_create(&self, _query: &QueryBuilder) -> Result<String, Error>

Convert to SQLite for creating a table

fn to_sqlite(&self) -> String

Convert to generic SQLite (only use for some generic types)

fn on_select(&self, query: &QueryBuilder) -> Result<String, Error>

Convert to SQLite for selecting a row

fn on_insert(&self, query: &QueryBuilder) -> Result<(String, Values), Error>

Convert to SQLite for inserting a row

fn on_update(&self, query: &QueryBuilder) -> Result<(String, Values), Error>

Convert to SQLite for updating a row

fn on_delete(&self, query: &QueryBuilder) -> Result<(String, Values), Error>

Convert to SQLite for deleting a row

fn on_alter(&self, query: &AlterQuery) -> Result<String, Error>

Convert to SQLite for altering a table

impl<T> Copy for PrimaryKey<T>
where T: Serialize + 'static + Copy,

impl<T> Eq for PrimaryKey<T>
where T: Serialize + 'static + Eq,

impl<T> StructuralPartialEq for PrimaryKey<T>
where T: Serialize + 'static,

Auto Trait Implementations§

impl<T> Freeze for PrimaryKey<T>
where T: Freeze,

impl<T> RefUnwindSafe for PrimaryKey<T>
where T: RefUnwindSafe,

impl<T> Send for PrimaryKey<T>
where T: Send,

impl<T> Sync for PrimaryKey<T>
where T: Sync,

impl<T> Unpin for PrimaryKey<T>
where T: Unpin,

impl<T> UnwindSafe for PrimaryKey<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,