Struct ApiToken 

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

A wrapper type for API tokens that prevents accidental exposure.

Internally uses SecretString from the secrecy crate for memory zeroing on drop and debug redaction. Adds serialization support by exposing the secret during serialization operations.

Implementations

impl ApiToken

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

Creates a new API token from any type that can be converted into a String.

Examples

use torrust_tracker_deployer_types::secrets::ApiToken;

let from_string = ApiToken::new(String::from("token"));
let from_str = ApiToken::new("token");

pub fn expose_secret(&self) -> &str

Exposes the secret API token value.

This method should be used carefully as it provides access to the sensitive data.

Debug Tracing

In debug builds, this method logs the caller location to help audit secret access patterns. No performance impact in release builds.

Trait Implementations

impl Clone for ApiToken

fn clone(&self) -> ApiToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiToken

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ApiToken

impl From<&str> for ApiToken

fn from(token: &str) -> ApiToken

Converts to this type from the input type.

impl From<String> for ApiToken

fn from(token: String) -> ApiToken

Converts to this type from the input type.

impl PartialEq for ApiToken

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ApiToken

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.