Struct SecretString 

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

A wrapped API token that can never leak through formatting or JSON.

The raw value is only reachable through AsRef<str> and [From<SecretString> for String] - i.e. the Bearer-header construction path. Debug, Display, and Serialize all emit a redaction marker.

Implementations

impl SecretString

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

Wrap a token value. The caller is responsible for the value being a real credential; this type only guarantees it never leaks.

pub fn bearer_header(&self) -> String

The Authorization: Bearer <token> header value.

Trait Implementations

impl AsRef<str> for SecretString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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.

impl Eq for SecretString

impl From<&str> for SecretString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<SecretString> for String

fn from(secret: SecretString) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> Self

Converts to this type from the input type.

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: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes as the literal "<redacted>" - the raw token can never reach JSON output, even through a derived Serialize impl.

impl StructuralPartialEq for SecretString