ClientSecrets

Struct ClientSecrets 

Source
pub struct ClientSecrets {
    pub client_id: String,
    pub project_id: String,
    pub auth_uri: String,
    pub token_uri: String,
    pub auth_provider_x509_cert_url: String,
    pub client_secret: String,
    pub redirect_uris: Vec<String>,
}
Expand description

Representation of the client_secrets JSON file that contains the authorization info for your API.

use drive_v3::ClientSecrets;
use drive_v3::AccessToken;

let secrets_path = "my_secrets.json";
let my_client_secrets = ClientSecrets::from_file(&secrets_path)?;

// Now you can requests access tokens with your client secrets
let scopes = ["https://www.googleapis.com/auth/drive.metadata.readonly"];
let my_access_token = AccessToken::request(&my_client_secrets, &scopes)?;

// After getting your token you can make a request (with reqwest for example) using it for authorization
let client = reqwest::blocking::Client::new();
let body = client.get("google-api-endpoint")
    .bearer_auth(&my_access_token.access_token)
    .send()?
    .text()?;

println!("response: {:?}", body);

Fields§

§client_id: String

Your API’s client ID.

§project_id: String

Your API’s project ID.

§auth_uri: String

The URI your API can call to request authorization.

§token_uri: String

The URI your API can call to request an AccessToken.

§auth_provider_x509_cert_url: String

Your API’s certificate provider URL.

§client_secret: String

Your API’s client secret.

§redirect_uris: Vec<String>

Your API’s redirect URIs.

Implementations§

Source§

impl ClientSecrets

Source

pub fn from_file<T: AsRef<Path>>(file: T) -> Result<Self>

Gets ClientSecrets from file.

§Examples
use drive_v3::ClientSecrets;
use drive_v3::AccessToken;

let secrets_path = "my_secrets.json";
let my_client_secrets = ClientSecrets::from_file(&secrets_path)?;

// Now you can requests access tokens with your client secrets
let scopes = ["https://www.googleapis.com/auth/drive.metadata.readonly"];
let my_access_token = AccessToken::request(&my_client_secrets, &scopes)?;

// After getting your token you can make a request (with reqwest for example) using it for authorization
let client = reqwest::blocking::Client::new();
let body = client.get("google-api-endpoint")
    .bearer_auth(&my_access_token.access_token)
    .send()?
    .text()?;

println!("response: {:?}", body);
§Errors
  • an IO error, if the file does not exist.
  • a Json error, if parsing of the file from json failed.
Source

pub fn get_authorization_code<T: AsRef<str>>( &self, scopes: &[T], open_browser: bool, ) -> Result<(String, String)>

Requests and authorization code and it’s associated code_verifier from Google’s API.

This code can be used to request AccessTokens using OAuth2.

§Note:

Do not use this function directly in drive_v3 unless you need to make custom requests using an authorization code, instead use the Credentials struct to easily handle authorization.

§Examples:

See Google’s official handle OAuth 2.0 responses documentation for information on what to use these codes for.

§Errors
  • a HexDecoding or UrlParsing error, if the creation of the code verifier failed.
  • a UrlParsing error, if the creation of the authorization request’s URL failed.
  • a LocalServer or IO error, if the LocalServer failed to listen for incoming requests.
  • a UrlParsing error, if unable to get the query containing the returned authorization code.
  • a MismatchedState error, if the state contained on the response doesn’t match the originally created one.
  • a MismatchedScopes error, if the user didn’t authorize all the requested scopes.
  • a NoAuthorizationCode error, if the response didn’t contain an authorization code.

Trait Implementations§

Source§

impl Clone for ClientSecrets

Source§

fn clone(&self) -> ClientSecrets

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientSecrets

Available on non-tarpaulin_include only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClientSecrets

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ClientSecrets

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ClientSecrets

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ClientSecrets

Source§

impl StructuralPartialEq for ClientSecrets

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,