Struct Dynamic 

pub struct Dynamic<T: ?Sized>(pub Box<T>);

A zero-cost, heap-allocated wrapper for sensitive data.

See module docs for full examples.

Tuple Fields

0: Box<T>

Implementations

impl<T: ?Sized> Dynamic<T>

pub fn new_boxed(value: Box<T>) -> Self

pub fn new<U>(value: U) -> Self

where U: Into<Box<T>>,

impl<T: ?Sized> Dynamic<T>

pub fn expose_secret(&self) -> &T

Access the secret value immutably.

Examples

use secure_gate::Dynamic;

let pw: Dynamic<String> = "secret".into();
assert_eq!(pw.expose_secret(), "secret");

pub fn expose_secret_mut(&mut self) -> &mut T

pub fn into_inner(self) -> Box<T>

impl Dynamic<String>

pub fn finish_mut(&mut self) -> &mut String

impl Dynamic<Vec<u8>>

pub fn finish_mut(&mut self) -> &mut Vec<u8>

Trait Implementations

impl<T: Clone + Zeroize> Clone for Dynamic<T>

Available on crate feature zeroize only.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for Dynamic<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Dynamic<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized> DerefMut for Dynamic<T>

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

Mutably dereferences the value.

impl From<&str> for Dynamic<String>

Convenience: &str → password secret.

use secure_gate::Dynamic;

let pw: Dynamic<String> = "correct horse battery staple".into();
assert_eq!(&*pw, "correct horse battery staple");

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<Box<T>> for Dynamic<T>

fn from(boxed: Box<T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Zeroize> From<Dynamic<T>> for DynamicZeroizing<T>

Available on crate feature zeroize only.

fn from(dynamic: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for Dynamic<T>

where T: Sized,

Convert any owned value into a heap secret.

Examples

use secure_gate::Dynamic;

let pw: Dynamic<String> = "hunter2".into();
let data: Dynamic<Vec<u8>> = vec![1, 2, 3].into();

assert_eq!(&*pw, "hunter2");
assert_eq!(data.expose_secret(), &[1, 2, 3]);

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Zeroize + DefaultIsZeroes> Zeroize for Dynamic<T>

Available on crate feature zeroize only.

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T: ?Sized + Zeroize> ZeroizeOnDrop for Dynamic<T>

Available on crate feature zeroize only.