Struct ApiKey

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

The API key used for authentication.

Implementations

impl ApiKey

pub fn token(&self) -> &str

Returns the API key as a string.

pub fn teams_level_from_env() -> Result<Self>

Creates a new teams-level API key from the ENV_API_KEY environment variable.

pub fn user_level_from_env() -> Result<Self>

Creates a new user-level API key from the ENV_API_KEY environment variable.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl Default for ApiKey

fn default() -> ApiKey

Returns the “default value” for a type.

impl From<&str> for ApiKey

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for ApiKey

fn from(s: String) -> Self

Converts to this type from the input 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 Eq for ApiKey

impl StructuralPartialEq for ApiKey