Struct Key 

pub struct Key {
    pub name: String,
    pub value: String,
}

An API Key used to authenticate with the REST API using HTTP Basic Auth.

Fields

name: String

value: String

Implementations

impl Key

pub fn new(s: &str) -> Result<Self>

impl Key

pub fn sign(&self, params: &TokenParams) -> Result<TokenRequest>

Use the API key to sign the given TokenParams, returning a signed TokenRequest which can be exchanged for a token.

Example

use std::convert::TryFrom;
use ably::auth;

let key = auth::Key::try_from("ABC123.DEF456:XXXXXXXXXXXX").unwrap();

let mut params = auth::TokenParams::default();
params.client_id = Some("test@example.com".to_string());

let req = key.sign(&params).unwrap();

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Key

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Key

fn try_from(s: &str) -> Result<Self>

Parse an API Key from a string of the form ‘:’.

Example

use std::convert::TryFrom;
use ably::auth;

let res = auth::Key::try_from("ABC123.DEF456:XXXXXXXXXXXX");
assert!(res.is_ok());

let res = auth::Key::try_from("not-a-valid-key");
assert!(res.is_err());

type Error = Error

The type returned in the event of a conversion error.

impl Eq for Key

impl StructuralPartialEq for Key