Struct SecretString 

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

A secure wrapper for sensitive strings like API keys

This type ensures that sensitive data is never accidentally logged or displayed. When debugging or displaying, it shows only a masked version of the string.

Security Features

• Debug trait shows masked value (first 4 chars + “…”)
• Display trait shows masked value
• Serialize shows masked value
• Clone and comparison work on full value

Example

use ggen_ai::security::SecretString;

let api_key = SecretString::new("sk-1234567890abcdef".to_string());
println!("{}", api_key); // Prints: "sk-1..."
println!("{:?}", api_key); // Prints: SecretString("sk-1...")

Implementations

impl SecretString

pub fn new(value: String) -> Self

Create a new SecretString

pub fn expose_secret(&self) -> &str

Get the underlying value (use with caution!)

Security Warning

This exposes the raw secret value. Only use this when you need to pass the secret to an API client or similar trusted code.

pub fn is_empty(&self) -> bool

Check if the secret is empty

pub fn len(&self) -> usize

Get the length of the secret

pub fn mask(&self) -> String

Create a masked version of the secret for display

Shows first 4 characters followed by “…” for security. If the secret is shorter than 8 characters, shows fewer chars.

pub fn from_string(s: &str) -> Self

Convert from a plain string

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<'de> Deserialize<'de> for SecretString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Formats the value using the given formatter.

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecretString

impl StructuralPartialEq for SecretString