Struct ApiKey 

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

An API key value that redacts its debug representation.

Implementations

impl ApiKey

pub fn new(value: impl AsRef<str>) -> Result<Self, ApiPrimitiveError>

Creates validated API key text metadata.

Errors

Returns ApiPrimitiveError when the value is empty or contains control characters.

pub fn parse(value: impl AsRef<str>) -> Result<Self, ApiPrimitiveError>

Parses validated API key text metadata.

Errors

Returns ApiPrimitiveError when validation fails.

pub fn as_str(&self) -> &str

Returns the stored API key text.

pub fn into_string(self) -> String

Consumes the key and returns the stored text.

impl ApiKey

pub fn redacted(&self) -> String

Returns a safely redacted key string.

Trait Implementations

impl AsRef<str> for ApiKey

fn as_ref(&self) -> &str

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

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

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

Formats the value using the given formatter.

impl Display for ApiKey

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

Formats the value using the given formatter.

impl FromStr for ApiKey

type Err = ApiPrimitiveError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

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

impl Hash for ApiKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ApiKey

fn cmp(&self, other: &ApiKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for ApiKey

fn partial_cmp(&self, other: &ApiKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for ApiKey

type Error = ApiPrimitiveError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ApiKey

impl StructuralPartialEq for ApiKey