Struct oauth_credentials::Credentials

pub struct Credentials<T = String> {
    pub identifier: T,
    pub secret: T,
}

An OAuth "credentials" pair defined in RFC 5849 section 1.1.

This type represents:

• Client credentials (consumer key and secret) used to authenticate as a client.
• Temporary credentials (request token and secret) which represent an authorization request.
• Token credentials (access token and secret) which represent an access grant from a resource owner to a client.

In order to make requests on behalf of a resource owner, you (the client) need a set of client credentials and token credentials, which is represented by the Token type.

In a typical authorization flow, you only have client credentials at the beginning. To obtain token credentials, you first obtain a set of temporary credentials using the client credentials. And after the resource owner approves the authorization request, you use the temporary credentials to request a set of token credentials from the server.

Fields

identifier: T

The unique identifier part of the credentials pair.

secret: T

The shared secret part of the credentials pair.

Implementations

impl<T: AsRef<str>> Credentials<T>

pub fn new(identifier: T, secret: T) -> Self

Creates a new Credentials.

pub fn identifier(&self) -> &str

Returns the unique identifier part of the credentials pair.

pub fn secret(&self) -> &str

Returns the shared secret part of the credentials pair.

pub fn as_ref(&self) -> Credentials<&str>

Converts from &Credentials<T> to Credentials<&str>.

impl<T> Credentials<T>

pub fn map<U, F>(self, mut f: F) -> Credentials<U> where
    F: FnMut(T) -> U,
    U: AsRef<str>, 

Maps a Credentials<T> to Credentials<U> by applying a function to contained values.

Example

async fn get_temporary_credentials() -> Credentials { /* ... */ }
let boxed: Credentials<Box<str>> = get_temporary_credentials().await.map(Into::into);

Trait Implementations

impl<T: Clone> Clone for Credentials<T>

pub fn clone(&self) -> Credentials<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Credentials<T>

impl<T: Debug> Debug for Credentials<T>

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

Formats the value using the given formatter.

impl<'a, T: AsRef<str>> From<&'a Credentials<T>> for Credentials<&'a str>

pub fn from(credentials: &'a Credentials<T>) -> Self

Performs the conversion.