Struct SecretToken 

pub struct SecretToken(/* private fields */);

A sensitive token string that is zeroized on drop and hidden from debug output.

SecretToken wraps a String and enforces two invariants:

• Zeroized on drop: the backing memory is overwritten with zeros when the token goes out of scope, preventing it from lingering in memory.
• Opaque debug: the Debug implementation prints "***" instead of the actual value, so tokens won’t leak into logs or error messages.

Use SecretToken::new to wrap a string value (e.g. an access key loaded from configuration or an environment variable).

Implementations

impl SecretToken

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

Create a new SecretToken from a string value.

pub fn as_str(&self) -> &str

Expose the inner token string for FFI boundaries.

Trait Implementations

impl Clone for SecretToken

fn clone(&self) -> SecretToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretToken

fn deserialize<__D>( __deserializer: __D, ) -> Result<SecretToken, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretToken

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl OpaqueDebug for SecretToken

impl Serialize for SecretToken

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.