Struct SecretString 

#[non_exhaustive]
pub struct SecretString(/* private fields */);

A bearer credential whose contents never appear in Debug or Display output or in logs.

Wrap a secret, such as the gateway bearer key, in a SecretString as soon as you read it, so an accidental {:?} or log line cannot leak it. The client reads the value only to set the Authorization header of its requests.

Implementations

impl SecretString

pub fn new(secret: impl Into<String>) -> Result<SecretString, SecretError>

Wraps a secret so it is redacted everywhere it is formatted.

Errors

Returns SecretError::Empty when secret is empty, so a client can never be built to authenticate with a blank bearer credential.

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.