Struct SecretBox 

pub struct SecretBox<S: Zeroize + ?Sized> { /* private fields */ }

Heap-allocated secret wrapper — mirrors secrecy::SecretBox.

Stores the secret in a Box<S>, zeroizes on drop, and only exposes the inner value through ExposeSecret / ExposeSecretMut. Debug always prints [REDACTED].

Migration to native secure-gate

For sized types, convert to Dynamic<S> using the provided From impl:

use secure_gate::compat::v10::SecretBox;
use secure_gate::Dynamic;

let compat: SecretBox<String> = SecretBox::init_with(|| String::from("hunter2"));
let native: Dynamic<String> = compat.into();

Implementations

impl<S: Zeroize + ?Sized> SecretBox<S>

pub fn new(boxed_secret: Box<S>) -> Self

Creates a SecretBox from a pre-boxed value.

impl<S: Zeroize + Default> SecretBox<S>

pub fn init_with_mut(ctr: impl FnOnce(&mut S)) -> Self

Creates a SecretBox by initializing the default value in-place via a mutable closure.

impl<S: Zeroize + Clone> SecretBox<S>

pub fn init_with(ctr: impl FnOnce() -> S) -> Self

Creates a SecretBox from the return value of ctr.

Makes an effort to zeroize the stack copy before boxing, but this is best-effort. Prefer init_with_mut when possible.

pub fn try_init_with<E>(ctr: impl FnOnce() -> Result<S, E>) -> Result<Self, E>

Fallible variant of init_with.

Trait Implementations

impl<S: CloneableSecret> Clone for SecretBox<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Zeroize + ?Sized> Debug for SecretBox<S>

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

Formats the value using the given formatter.

impl<S: Zeroize + Default> Default for SecretBox<S>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for SecretBox<T>

where T: Zeroize + Clone + DeserializeOwned + Sized,

Available on crate feature serde-deserialize only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Zeroize + ?Sized> Drop for SecretBox<S>

fn drop(&mut self)

Executes the destructor for this type.

impl<S: Zeroize + ?Sized> ExposeSecret<S> for SecretBox<S>

fn expose_secret(&self) -> &S

Returns a shared reference to the inner secret.

impl<S: Zeroize + ?Sized> ExposeSecretMut<S> for SecretBox<S>

fn expose_secret_mut(&mut self) -> &mut S

Returns a mutable reference to the inner secret.

impl<S: Zeroize + ?Sized> From<Box<S>> for SecretBox<S>

fn from(source: Box<S>) -> Self

Converts to this type from the input type.

impl From<Dynamic<String>> for SecretBox<String>

Converts a Dynamic<String> back into a SecretBox<String>.

Clones the inner String. Both the source and the new wrapper are zeroized on drop.

fn from(d: Dynamic<String>) -> Self

Converts to this type from the input type.

impl<S: Clone + Zeroize + 'static> From<Dynamic<Vec<S>>> for SecretBox<Vec<S>>

Converts a Dynamic<Vec<S>> back into a SecretBox<Vec<S>>.

Clones the inner Vec. Both ends are zeroized on drop.

fn from(d: Dynamic<Vec<S>>) -> Self

Converts to this type from the input type.

impl<S: Clone + Zeroize + 'static> From<SecretBox<S>> for Dynamic<S>

Converts a SecretBox<S> into a Dynamic<S> (primary migration path).

Requires S: Clone because the inner Box<S> cannot be moved out of SecretBox without unsafe code (SecretBox has a Drop impl). The clone is immediately wrapped in Dynamic and the original is zeroized on drop.

For zero-copy migration, construct Dynamic<S> directly instead.

fn from(sb: SecretBox<S>) -> Self

Converts to this type from the input type.

impl From<SecretBox<str>> for Dynamic<String>

Converts a SecretString (= SecretBox<str>) into a Dynamic<String>.

Clones the inner str into a new String. Both ends are zeroized on drop.

fn from(sb: SecretString) -> Self

Converts to this type from the input type.

impl<T> Serialize for SecretBox<T>

where T: Zeroize + SerializableSecret + Serialize + Sized,

Available on crate feature serde-serialize only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: Zeroize + ?Sized> Zeroize for SecretBox<S>

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<S: Zeroize + ?Sized> ZeroizeOnDrop for SecretBox<S>