Struct Encrypted 

pub struct Encrypted<T>(/* private fields */);

A field stored encrypted (AES-256-GCM under APP_KEY), read and written as a plain T in Rust: a national id number, a bank account, a third-party API secret. Laravel’s encrypted cast.

use renox::db::Encrypted;

#[derive(Model, serde::Serialize, Default)]
#[model(table = "suppliers")]
struct Supplier {
    id: i64,
    name: String,
    bank_account: Encrypted<String>, // a TEXT column holding the sealed value
    api_key: Option<Encrypted<String>>,
}

let supplier = Supplier::create(&db, Supplier {
    name: "Corner Coffee".into(),
    bank_account: Encrypted::new("BCA 123-456-789".into()),
    ..Default::default()
}).await?;
assert_eq!(*supplier.bank_account, "BCA 123-456-789"); // `Deref` to the value

The value is sealed with the key of the Db that writes it and opened with the key of the one that reads it (the app’s APP_KEY, set at boot), so it works the same in handlers, jobs, commands, seeders and tests. Each write uses a fresh nonce, so the column can’t be searched or indexed: look rows up by another column. Changing APP_KEY makes the values unreadable. T is stored as JSON, so any serde type works.

Debug prints Encrypted(..), never the value; Serialize writes the plain value (for your JSON and templates, where you decide to show it).

Implementations

impl<T> Encrypted<T>

pub fn new(value: T) -> Self

Wraps a plain value; it is encrypted when the model is saved.

pub fn into_inner(self) -> T

The plain value.

Trait Implementations

impl<T: Clone> Clone for Encrypted<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 for Encrypted<T>

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

Formats the value using the given formatter.

impl<'r, T: DeserializeOwned> Decode<'r, Postgres> for Encrypted<T>

fn decode( value: <Postgres as Database>::ValueRef<'r>, ) -> Result<Self, BoxDynError>

Decode a new value of this type using a raw value from the database.

impl<'r, T: DeserializeOwned> Decode<'r, Sqlite> for Encrypted<T>

fn decode( value: <Sqlite as Database>::ValueRef<'r>, ) -> Result<Self, BoxDynError>

Decode a new value of this type using a raw value from the database.

impl<T: Default> Default for Encrypted<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Encrypted<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Encrypted<T>

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

Mutably dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Encrypted<T>

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

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Encrypted<T>

impl<T> From<T> for Encrypted<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Encrypted<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 Encrypted<T>

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for Encrypted<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Encrypted<T>

fn partial_cmp(&self, other: &Self) -> 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: Serialize> Serialize for Encrypted<T>

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

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Encrypted<T>

impl<T: Serialize> ToDbValue for Encrypted<T>

fn to_db_value(&self) -> DbValue

The plain value as JSON; the statement seals it with its database’s key when it runs.

impl<T> Type<Postgres> for Encrypted<T>

fn type_info() -> <Postgres as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<Postgres as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<T> Type<Sqlite> for Encrypted<T>

fn type_info() -> <Sqlite as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<Sqlite as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.