Struct SensitiveString 

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

A string-like type containing sensitive information such as passwords or tokens.

It is redacted from debug logs and automatically zeroized.

Example

use iceberg::sensitive::SensitiveString;

let sensitive_value = "my-pw-12345";
let sensitive_string = SensitiveString::from(sensitive_value.to_string());

// Not contained in debug logs.
assert!(!format!("{:?}", sensitive_string).contains(sensitive_value));

Display

SensitiveString does not implement [Display] to prevent bugs like:

// We don't want to send a redacted `Bearer: *****`.
let auth_header = format!("Bearer {}", SensitiveString::from("token".to_string()));

Instead use an explicit SensitiveString::expose when you need it:

let auth_header = format!(
    "Bearer: {}",
    SensitiveString::from("token".to_string()).expose()
);

Implementations

impl SensitiveString

pub fn expose(&self) -> &str

Returns the raw value of the sensitive string.

pub fn is_empty(&self) -> bool

Returns true if the string value is empty.

Trait Implementations

impl Clone for SensitiveString

fn clone(&self) -> SensitiveString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SensitiveString

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

Formats the value using the given formatter.

impl From<String> for SensitiveString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for SensitiveString

fn eq(&self, other: &SensitiveString) -> 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 Eq for SensitiveString

impl StructuralPartialEq for SensitiveString