Struct Encryption 

pub struct Encryption { /* private fields */ }

The application’s encrypter and signer, as one container-storable value.

A newtype over the two ports rather than binding them separately, so swapping either does not change a call site — the same reason rainier-framework’s Views wraps a view engine.

Implementations

impl Encryption

pub fn new(encrypter: Arc<dyn Encrypter>, signer: Arc<dyn Signer>) -> Encryption

Wrap an encrypter and a signer.

pub fn from_keys(keys: KeyRing) -> Encryption

The default pairing — XChaCha20-Poly1305 and HMAC-SHA256 over one ring.

pub fn from_keys_with(keys: KeyRing, cipher: Cipher) -> Encryption

The same, with an explicit Cipher.

Reading is unaffected: a payload names its own algorithm, so switching this does not strand anything already written.

pub fn keys(&self) -> Option<&KeyRing>

The key ring, when this was built from one.

None when the encrypter and signer were supplied separately — see new. A caller that needs a ring of its own should ask for one rather than assume.

pub fn encrypter(&self) -> &Arc<dyn Encrypter>

The encrypter.

pub fn signer(&self) -> &Arc<dyn Signer>

The signer.

pub fn encrypt(&self, plain: &str) -> Result<String, Error>

Encrypt a string.

pub fn decrypt(&self, payload: &str) -> Result<String, Error>

Decrypt a string.

pub fn encrypt_bytes(&self, plain: &[u8]) -> Result<String, Error>

Encrypt raw bytes.

pub fn decrypt_bytes(&self, payload: &str) -> Result<Vec<u8>, Error>

Decrypt to raw bytes.

pub fn encrypt_json<T>(&self, value: &T) -> Result<String, Error>

where T: Serialize,

Encrypt any serialisable value as JSON.

pub fn decrypt_json<T>(&self, payload: &str) -> Result<T, Error>

where T: DeserializeOwned,

Decrypt JSON back into a value.

pub fn sign(&self, value: &str) -> Result<String, Error>

Sign a value, leaving it readable.

pub fn verify(&self, signed: &str) -> Result<String, Error>

Recover a signed value, or fail if it was altered.

pub fn is_valid(&self, signed: &str) -> bool

Whether a signed value is intact.

Trait Implementations

impl Clone for Encryption

fn clone(&self) -> Encryption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Encryption

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

Formats the value using the given formatter.