Struct Secret 

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

An access or refresh token.

Its Debug and Display print <redacted>, it has no Serialize, and its own buffer is zeroed when it is dropped. Secret::expose is the only way to read it.

Zeroing is best effort, not a guarantee that no copy is left in memory. Each clone is a separate buffer, zeroed when that clone drops. The client zeroes the response bodies it reads, but not the copies made outside it: the request body handed to reqwest (and its TLS and HTTP/2 buffers), reqwest’s received chunks, the String a caller passes to Secret::new, and whatever a caller does with Secret::expose.

Equality (==) is a plain string comparison, not constant-time: fine for the compare-and-swap a refresh needs, not for checking a token an untrusted party sent.

use ccwire_oauth::Secret;

let token = Secret::new("not-a-real-token");
assert_eq!(format!("{token} {token:?}"), "<redacted> Secret(<redacted>)");
assert_eq!(token.expose(), "not-a-real-token");

Implementations

impl Secret

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

Wraps a token.

pub fn expose(&self) -> &str

The token itself. Send it, compare it or store it; don’t log it.

pub fn is_empty(&self) -> bool

Whether the token is the empty string.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Default for Secret

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Secret

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

Deserialize this value from the given Serde deserializer.

impl Display for Secret

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

Formats the value using the given formatter.

impl Drop for Secret

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Secret

impl From<&str> for Secret

fn from(token: &str) -> Self

Converts to this type from the input type.

impl From<String> for Secret

fn from(token: String) -> Self

Converts to this type from the input type.

impl PartialEq for Secret

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Secret