Enum Auth 

#[non_exhaustive]
pub enum Auth {
    ApiKey(String),
    Token(String),
    Provider(Arc<dyn TokenProvider>),
}

Static credentials supplied to the client.

Ably accepts HTTP Basic auth with an API key (keyName:keySecret) or Bearer auth with an Ably Token/JWT. Auth::Provider refreshes on demand via a caller-supplied TokenProvider (ADR-0005).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ApiKey(String)

An Ably API key, keyName:keySecret, sent as HTTP Basic.

Token(String)

An Ably Token/JWT, sent as a Bearer token.

Provider(Arc<dyn TokenProvider>)

A caller-supplied provider that yields (and refreshes) Bearer credentials.

Implementations

impl Auth

pub fn api_key(key: impl Into<String>) -> Self

Constructs API-key (HTTP Basic) credentials from a keyName:keySecret.

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

Constructs Bearer-token credentials from an Ably Token/JWT.

pub fn provider(p: Arc<dyn TokenProvider>) -> Self

Constructs credentials backed by a refreshing TokenProvider.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.