Struct TokenRequest 

pub struct TokenRequest {
    pub key_name: String,
    pub ttl: Option<i64>,
    pub capability: Option<String>,
    pub client_id: Option<String>,
    pub timestamp: i64,
    pub nonce: String,
    pub mac: String,
}

TokenRequest : A signed token request. The mac is HMAC-SHA256 (base64) over the newline-joined fields keyName, ttl, capability, clientId, timestamp, nonce (each followed by a newline, empty fields included) using the API key secret. A signed request needs no Authorization header.

Fields

key_name: String

The API key name (appId.keyId) that signed this request.

ttl: Option<i64>

Requested time-to-live in milliseconds.

capability: Option<String>

A capability document as a JSON string (a stringified object mapping resource-name patterns to arrays of operations, e.g. {\"my-room\":[\"publish\",\"history\"]}). For a signed TokenRequest this string must be canonicalized (resource keys and operation arrays sorted, no whitespace) because it is part of the HMAC-signed text. See SPEC §13.

client_id: Option<String>

The identity to bind the token to.

timestamp: i64

Milliseconds since the Unix epoch when the request was created. Must be within ~2 minutes of Ably server time (see GET /time).

nonce: String

An opaque, cryptographically-random string of at least 16 characters, unique per request (replay protection).

mac: String

Base64 HMAC-SHA256 signature over the canonical request text.

Implementations

impl TokenRequest

pub fn new( key_name: String, timestamp: i64, nonce: String, mac: String, ) -> TokenRequest

A signed token request. The mac is HMAC-SHA256 (base64) over the newline-joined fields keyName, ttl, capability, clientId, timestamp, nonce (each followed by a newline, empty fields included) using the API key secret. A signed request needs no Authorization header.

Trait Implementations

impl Clone for TokenRequest

fn clone(&self) -> TokenRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenRequest

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

Formats the value using the given formatter.

impl Default for TokenRequest

fn default() -> TokenRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TokenRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenRequest