Struct SecretString 

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

Re-export SecretString so consumers (web-api, CLI, openapi-client) can use it without a direct uptrakit-shared-types dependency. A newtype wrapper for strings that contain sensitive data (secrets, tokens, passwords).

Security properties

• Debug and Display implementations redact the value, preventing accidental exposure in logs, error chains, and tracing output.
• ZeroizeOnDrop overwrites the backing heap allocation with zeros when the value is dropped.
• Serialize is transparent (#[serde(transparent)]): serializing a SecretString emits the plaintext value. Never serialize structs containing SecretString to logs or debug output — use Debug formatting instead.
• Clone creates a new heap allocation containing the secret. Each clone must be properly dropped (not leaked or stored in a non-zeroizing container) to ensure the zeroize guarantee is upheld.
• PartialEq uses the standard String comparison, which short-circuits on the first mismatched byte. Do not use PartialEq for authentication comparisons where timing side channels are a concern; use a constant-time comparison function instead (e.g., subtle::ConstantTimeEq or argon2::password_hash::PasswordVerifier).

Implementations

impl SecretString

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

Wrap a plaintext value.

pub fn expose_secret(&self) -> &str

Borrow the plaintext secret.

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<(), Error>

Formats the value using the given formatter.

impl Default for SecretString

fn default() -> SecretString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretString

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Drop for SecretString

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

impl Hash for SecretString

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SecretString

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SecretString

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.

impl StructuralPartialEq for SecretString

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.