Struct inth_oauth2::client::Client

pub struct Client<P> {
    pub provider: P,
    pub client_id: String,
    pub client_secret: String,
    pub redirect_uri: Option<String>,
}

OAuth 2.0 client.

Fields

provider: P

OAuth provider.

client_id: String

Client ID.

client_secret: String

Client secret.

redirect_uri: Option<String>

Redirect URI.

Implementations

impl<P: Provider> Client<P>

pub fn new(
    provider: P,
    client_id: String,
    client_secret: String,
    redirect_uri: Option<String>
) -> Self

Creates a client.

Examples

use inth_oauth2::Client;
use inth_oauth2::provider::google::Installed;

let client = Client::new(
    Installed,
    String::from("CLIENT_ID"),
    String::from("CLIENT_SECRET"),
    Some(String::from("urn:ietf:wg:oauth:2.0:oob")),
);

pub fn auth_uri(&self, scope: Option<&str>, state: Option<&str>) -> Url

Returns an authorization endpoint URI to direct the user to.

See RFC 6749, section 3.1.

Examples

use inth_oauth2::Client;
use inth_oauth2::provider::google::Installed;

let client = Client::new(
    Installed,
    String::from("CLIENT_ID"),
    String::from("CLIENT_SECRET"),
    Some(String::from("urn:ietf:wg:oauth:2.0:oob")),
);

let auth_uri = client.auth_uri(
    Some("https://www.googleapis.com/auth/userinfo.email"),
    None,
);

pub fn request_token(
    &self,
    http_client: &Client,
    code: &str
) -> Result<P::Token, ClientError>

Requests an access token using an authorization code.

See RFC 6749, section 4.1.3.

impl<P> Client<P>where
    P: Provider,
    P::Token: Token<Refresh>,

pub fn refresh_token(
    &self,
    http_client: &Client,
    token: P::Token,
    scope: Option<&str>
) -> Result<P::Token, ClientError>

Refreshes an access token.

See RFC 6749, section 6.

pub fn ensure_token(
    &self,
    http_client: &Client,
    token: P::Token
) -> Result<P::Token, ClientError>

Ensures an access token is valid by refreshing it if necessary.

Trait Implementations

impl<P: Clone> Clone for Client<P>

fn clone(&self) -> Client<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for Client<P>

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

Formats the value using the given formatter.

impl<P: PartialEq> PartialEq<Client<P>> for Client<P>

fn eq(&self, other: &Client<P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<P: Eq> Eq for Client<P>

impl<P> StructuralEq for Client<P>

impl<P> StructuralPartialEq for Client<P>