Struct KeyTokenProvider 

pub struct KeyTokenProvider { /* private fields */ }

Mints Ably Tokens by calling POST /keys/{keyName}/requestToken with an unsigned TokenParams body under HTTP Basic auth. Pair with Auth::provider for automatic use + refresh.

Implementations

impl KeyTokenProvider

pub fn new(api_key: impl AsRef<str>) -> Result<Self>

New provider from a full API key appId.keyId:keySecret.

pub fn capability(self, cap: impl Into<String>) -> Self

Restrict issued tokens to this capability (a JSON string; with the capabilities feature, build it via Capability::to_capability_string).

pub fn client_id(self, id: impl Into<String>) -> Self

Bind issued tokens to a clientId.

pub fn ttl(self, ttl: Duration) -> Self

Requested token TTL (default: Ably’s 60 minutes).

pub fn host(self, host: impl Into<String>) -> Self

Override the platform host (defaults to https://rest.ably.io).

pub fn http_client(self, client: Client) -> Self

Supply a preconfigured reqwest::Client.

Trait Implementations

impl Clone for KeyTokenProvider

fn clone(&self) -> KeyTokenProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyTokenProvider

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

Formats the value using the given formatter.

impl TokenProvider for KeyTokenProvider

fn token(&self) -> BoxFuture<'_, Result<String>>

Fetch a currently-valid token.