Struct egg_mode::auth::KeyPair

pub struct KeyPair {
    pub key: Cow<'static, str>,
    pub secret: Cow<'static, str>,
}

A key/secret pair representing the app that is sending a request or an authorization from a user.

This type is used as part of the authentication process and to sign API requests afterward. For the most part it's used internally as part of a Token, but at the very beginning of the authentication process, you'll need to manually create one to hold onto your "consumer token" and request a request token.

For more information, see the authentication documentation.

Example

let con_token = egg_mode::KeyPair::new("consumer key", "consumer token");

Fields

key: Cow<'static, str>

A key used to identify an application or user.

secret: Cow<'static, str>

A private key used to sign messages from an application or user.

Implementations

impl KeyPair

pub fn new<K, S>(key: K, secret: S) -> KeyPair where
    K: Into<Cow<'static, str>>,
    S: Into<Cow<'static, str>>, 

Creates a KeyPair with the given key and secret.

This can be called with either &'static str (a string literal) or String for either parameter.

Trait Implementations

impl Clone for KeyPair

fn clone(&self) -> KeyPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPair

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyPair

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for KeyPair

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

Serialize this value into the given Serde serializer.