Struct SecretString

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

A secure string type for sensitive configuration values like API keys.

This type ensures that sensitive values are not accidentally logged or displayed in debug output.

Implementations

impl SecretString

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

Create a new secret string

pub fn expose_secret(&self) -> &str

Get the secret value

Security Note

Be careful when using this method - the returned string can be logged or displayed if not handled properly.

pub fn is_empty(&self) -> bool

Check if the secret is empty

pub fn len(&self) -> usize

Get the length of the 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<'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 From<&str> for SecretString

fn from(value: &str) -> SecretString

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> SecretString

Converts to this type from the input type.

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.