Struct ApiKey 

pub struct ApiKey<Hash> { /* private fields */ }

Represents a generated API key with its hash.

The key field is stored in a SecureString which automatically zeros its memory on drop, preventing potential memory disclosure.

Implementations

impl<T> ApiKey<T>

pub fn key(&self) -> &SecureString

Returns a reference to the secure API key.

To access the underlying string, use .expose_secret() on the returned SecureString:

let key_str: &str = api_key.key().expose_secret();

Security Note

The key is stored in secure memory that is automatically zeroed on drop. Be careful NOT to clone or log the value unnecessarily.

impl ApiKey<NoHash>

pub fn new(key: SecureString) -> ApiKey<NoHash>

pub fn into_hashed(self, hasher: &KeyHasher) -> Result<ApiKey<Hash>>

pub fn into_key(self) -> SecureString

impl ApiKey<Hash>

pub fn hash(&self) -> &str

Returns hash. SECURITY: Although it’s safe to store hash, do NOT make unnecessary clones and avoid logging the hash.

pub fn into_key(self) -> SecureString

Trait Implementations

impl<Hash: Debug> Debug for ApiKey<Hash>

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

Formats the value using the given formatter.