Struct Secret 

pub struct Secret { /* private fields */ }

UTF-8 secret material whose backing bytes are overwritten when dropped.

This type intentionally does not implement Clone, Debug, Display, or serde traits. Callers must opt in to access through Secret::expose_secret. The standard-library-only overwrite is a defense-in-depth measure, not a compiler-guaranteed secure erasure primitive.

use rustferry_remote::Secret;
let secret = Secret::new("private-key-value");
println!("{secret:?}");

use rustferry_remote::Secret;
let secret = Secret::new("password-value");
let _copy = secret.clone();

use rustferry_remote::Secret;
let secret = Secret::new("password-value");
let _json = serde_json::to_string(&secret).unwrap();

Implementations

impl Secret

pub fn new(value: impl Into<String>) -> Self

Store one UTF-8 secret, taking ownership when the input is an owned string.

pub fn expose_secret(&self) -> &str

Expose the secret to the narrow operation that needs it.

Panics

This cannot panic through the public API because construction accepts only UTF-8 strings.

pub fn len(&self) -> usize

Return the secret length without exposing its contents.

pub fn is_empty(&self) -> bool

Return whether the secret is empty.

pub fn clear(&mut self)

Overwrite the currently held bytes before the value is dropped.

Trait Implementations

impl From<String> for Secret

fn from(value: String) -> Self

Converts to this type from the input type.