Struct TokenParams 

pub struct TokenParams {
    pub ttl: Option<i64>,
    pub capability: Option<String>,
    pub client_id: Option<String>,
}

TokenParams : An unsigned token request. Sent with HTTP Basic auth; Ably signs the token server-side. To request all of the key’s capabilities, omit capability.

Fields

ttl: Option<i64>

Requested time-to-live in milliseconds. Defaults to 3600000 (1 hour) when omitted. Tokens from a revocable-tokens key are capped at 1 hour.

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. The resulting token may only act as this clientId; * grants the privileged wildcard identity.

Implementations

impl TokenParams

pub fn new() -> TokenParams

An unsigned token request. Sent with HTTP Basic auth; Ably signs the token server-side. To request all of the key’s capabilities, omit capability.

Trait Implementations

impl Clone for TokenParams

fn clone(&self) -> TokenParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenParams

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

Formats the value using the given formatter.

impl Default for TokenParams

fn default() -> TokenParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TokenParams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenParams

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 TokenParams