Struct InnerSecret 

pub struct InnerSecret<T: Zeroize>(/* private fields */);

Owned, zeroizing secret extracted via [RevealSecret::into_inner].

InnerSecret<T> preserves the zeroization contract by wrapping zeroize::Zeroizing<T>, while restoring a strict redaction policy for Debug: formatting this type always prints [REDACTED], regardless of T.

This is not a secret wrapper like Fixed or Dynamic — it is the owned extraction result from into_inner(). It implements Deref<Target = T> (the only type in this crate that derefs to the secret).

Use into_zeroizing only when an API explicitly requires a Zeroizing<T> value.

Examples

use secure_gate::{Fixed, RevealSecret};

let key = Fixed::new([0xABu8; 4]);
let owned = key.into_inner();

// Deref access to the inner value.
assert_eq!(owned[0], 0xAB);

// Debug is redacted.
assert_eq!(format!("{:?}", owned), "[REDACTED]");

// Convert to Zeroizing<T> for interop.
let z = owned.into_zeroizing();

See also EncodedSecret — the encoded-string counterpart.

Implementations

impl<T: Zeroize> InnerSecret<T>

pub fn into_zeroizing(self) -> Zeroizing<T>

Unwraps and returns the underlying zeroize::Zeroizing<T>.

This is an explicit escape hatch for interoperability with APIs that accept Zeroizing<T> directly.

Trait Implementations

impl<T: Zeroize> Debug for InnerSecret<T>

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

Formats the value using the given formatter.

impl<T: Zeroize> Deref for InnerSecret<T>

Provides &T access via *inner_secret. This is the only type in the crate that implements Deref to the secret — Fixed and Dynamic deliberately do not.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.