Struct ApiKey 

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

API key for authenticating with the Odos API

Wraps a UUID-formatted API key in a type-safe manner with secure debug formatting that redacts the key value to prevent accidental logging.

Examples

use odos_sdk::ApiKey;
use std::str::FromStr;

let api_key = ApiKey::from_str("11111111-1a11-1111-a11a-aaa11a111a1a").unwrap();

// The key is redacted in debug output
println!("{:?}", api_key); // Prints: ApiKey([REDACTED])

Implementations

impl ApiKey

pub fn new(uuid: Uuid) -> Self

Create a new API key from a UUID

Arguments

• uuid - The API key as a UUID

Examples

use odos_sdk::ApiKey;
use uuid::Uuid;
use std::str::FromStr;

let uuid = Uuid::from_str("11111111-1a11-1111-a11a-aaa11a111a1a").unwrap();
let api_key = ApiKey::new(uuid);

pub fn as_uuid(&self) -> &Uuid

Get the underlying UUID

Security

Be careful when using this method - avoid logging or displaying the raw key value in production.

pub fn as_str(&self) -> String

Get the API key as a string

Security

Be careful when using this method - avoid logging or displaying the raw key value in production.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

Secure Debug implementation that redacts the API key

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

Formats the value using the given formatter.

impl Display for ApiKey

Display implementation that redacts the API key

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

Formats the value using the given formatter.

impl From<Uuid> for ApiKey

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl FromStr for ApiKey

type Err = OdosError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for ApiKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ApiKey

impl Eq for ApiKey

impl StructuralPartialEq for ApiKey