Struct Field

pub struct Field<T: TypeMarker> { /* private fields */ }

An generic type-safe object ID field (a wrapped u64).

When serialized with Serde, the number is automatically encrypted and encoded into a URL safe string. Deserialization decodes and decrypts the string back to an integer. The string has an object type specific prefix defined in the type marker’s fn name().

Traits are also provided for Diesel compatibility with Postgres BigInt fields.

Examples

use cryptid_rs;
use serde::{Serialize, Deserialize};
use serde_json;

#[derive(Clone, Copy, Debug)]
pub struct ExampleIdMarker;
impl cryptid_rs::TypeMarker for ExampleIdMarker {
    fn name() -> &'static str { "example" }
}

type ExampleId = cryptid_rs::Field<ExampleIdMarker>;

#[derive(serde::Serialize)]
struct Example {
    pub id: ExampleId,
}

cryptid_rs::Config::set_global(cryptid_rs::Config::new(b"your-secure-key"));
let obj = Example {id: ExampleId::from(12345)};
let obj_str = serde_json::to_string(&obj).unwrap();
assert_eq!(obj_str, "{\"id\":\"example_VgwPy6rwatl\"}");

Implementations

impl<T: TypeMarker> Field<T>

pub fn from(id: u64) -> Self

Creates a Field<T> value from a u64.

This method converts a u64 into a Field<T>, effectively changing its type.

pub fn encode_uuid(self) -> Uuid

Encrypts the ID into a Uuid value.

Trait Implementations

impl<'__expr, T: TypeMarker> AsExpression<BigInt> for &'__expr Field<T>

type Expression = Bound<BigInt, &'__expr Field<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<BigInt>>::Expression

Perform the conversion

impl<T: TypeMarker> AsExpression<BigInt> for Field<T>

type Expression = Bound<BigInt, Field<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<BigInt>>::Expression

Perform the conversion

impl<'__expr, T: TypeMarker> AsExpression<Nullable<BigInt>> for &'__expr Field<T>

type Expression = Bound<Nullable<BigInt>, &'__expr Field<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<BigInt>>>::Expression

Perform the conversion

impl<T: TypeMarker> AsExpression<Nullable<BigInt>> for Field<T>

type Expression = Bound<Nullable<BigInt>, Field<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<BigInt>>>::Expression

Perform the conversion

impl<T: Clone + TypeMarker> Clone for Field<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + TypeMarker> Debug for Field<T>

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

Formats the value using the given formatter.

impl<'de, T: TypeMarker> Deserialize<'de> for Field<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: TypeMarker> Display for Field<T>

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

Formats the value using the given formatter.

impl<T: TypeMarker> From<Field<T>> for u64

fn from(field: Field<T>) -> Self

Returns the raw u64 value.

impl<T: TypeMarker> FromSql<BigInt, Pg> for Field<T>

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql( bytes: Option<<DB as Backend>::RawValue<'_>>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

A specialized variant of from_sql for handling null values.

impl<T> Queryable<BigInt, Pg> for Field<T>

where T: TypeMarker,

type Row = <i64 as Queryable<BigInt, Pg>>::Row

The Rust type you’d like to map from.

fn build(row: Self::Row) -> Result<Self>

Construct an instance of this type

impl<T: TypeMarker> Serialize for Field<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TypeMarker> ToSql<BigInt, Pg> for Field<T>

fn to_sql(&self, out: &mut Output<'_, '_, Pg>) -> Result

See the trait documentation.

impl<T: TypeMarker, __DB> ToSql<Nullable<BigInt>, __DB> for Field<T>

where __DB: Backend, Self: ToSql<BigInt, __DB>,

fn to_sql<'__b>(&'__b self, out: &mut Output<'__b, '_, __DB>) -> Result

See the trait documentation.

impl<T: Copy + TypeMarker> Copy for Field<T>