Struct ApiKey 

pub struct ApiKey { /* private fields */ }

A parsed OpenApp API-key token.

Implementations

impl ApiKey

pub fn parse(token: impl Into<String>) -> Result<ApiKey, TokenFormatError>

Parse a token string of the form {origin}_openapp_{secret}.

Errors

Returns a TokenFormatError if the token is empty, lacks the separator, has an empty secret, or if origin is not a bare absolute http(s) origin.

pub fn origin(&self) -> &Url

The deployment origin the token was issued by.

pub fn api_base_url(&self) -> Url

The versioned API root requests are resolved against: {origin}/api/v1.

pub fn secret(&self) -> &str

The secret component of the token (never log this).

pub fn as_str(&self) -> &str

The full token string, exactly as the backend issued it. This is the value sent in the X-API-Key header.

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

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

Formats the value using the given formatter.

impl Display for ApiKey

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

Formats the value using the given formatter.

impl Eq for ApiKey

impl PartialEq for ApiKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiKey