Struct SecretString 

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

A secure string that is automatically zeroed when dropped.

Use this for API keys, secrets, passwords, and other sensitive data. The underlying memory is securely cleared when the value is dropped, preventing credential leakage through memory inspection.

Security Features

• Memory is zeroed on drop using the zeroize crate
• Debug and Display implementations are redacted to prevent accidental logging
• Clone creates a new zeroed copy (original remains secure)

Example

use ccxt_core::credentials::SecretString;

let secret = SecretString::new("my-secret-key");

// Use expose_secret() to access the value
assert_eq!(secret.expose_secret(), "my-secret-key");

// Debug output is safe
println!("{:?}", secret); // Prints: [REDACTED]

Implementations

impl SecretString

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

Creates a new secret string.

Arguments

• value - The secret value to store

Example

use ccxt_core::credentials::SecretString;

let secret = SecretString::new("api-key-12345");

pub fn expose_secret(&self) -> &str

Returns the secret value.

Security

Avoid storing the returned reference longer than necessary. The reference should be used immediately and not persisted.

Example

use ccxt_core::credentials::SecretString;

let secret = SecretString::new("my-key");
let value = secret.expose_secret();
// Use value immediately, don't store it

pub fn expose_secret_bytes(&self) -> &[u8]

Returns the secret as bytes.

Security

Same security considerations as expose_secret() apply.

pub fn len(&self) -> usize

Returns the length of the secret string.

pub fn is_empty(&self) -> bool

Returns true if the secret string is empty.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretString

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

Formats the value using the given formatter.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Drop for SecretString

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for SecretString

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecretString

fn eq(&self, other: &SecretString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Zeroize for SecretString

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 Eq for SecretString

impl StructuralPartialEq for SecretString