Struct Key

pub struct Key<T> { /* private fields */ }

A type that is suitable for keys in the database.

Internally it uses an Ulid. It is randomly generated and contains 80 bits of entropy. The first 48 bits encode a timestamp such that the keys are ordered by time of insertion

Chance of collision is negligible - 4e-7 if a billion keys are generated in the same millisecond.

Implementations

impl<T: Table> Key<T>

pub fn from_untyped(key: Key) -> Self

pub fn new() -> Self

pub async fn fetch<C: GenericClient + Sync>( self, client: &C, ) -> Result<Option<T>, Error>

pub async fn delete<C: GenericClient + Sync>( self, client: &C, ) -> Result<u64, Error>

pub fn inner(&self) -> Ulid

pub fn timestamp(&self) -> NaiveDateTime

pub fn untyped(&self) -> Key

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Table> FromSql<'_> for Key<T>

fn from_sql(ty: &Type, raw: &[u8]) -> Result<Self, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql_null(ty: &Type) -> Result<Self, Box<dyn Error + Sync + Send>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable( ty: &Type, raw: Option<&'a [u8]>, ) -> Result<Self, Box<dyn Error + Sync + Send>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.

impl<T: Hash> Hash for Key<T>

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<T: Ord> Ord for Key<T>

fn cmp(&self, other: &Key<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Key<T>

fn eq(&self, other: &Key<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: PartialOrd> PartialOrd for Key<T>

fn partial_cmp(&self, other: &Key<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Debug + Table> ToSql for Key<T>

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(ty: &Type) -> bool

where Self: Sized,

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl<T: Table> Copy for Key<T>

impl<T: Eq> Eq for Key<T>

impl<T> StructuralPartialEq for Key<T>