Struct reqwest_oauth1::OAuthParameters

pub struct OAuthParameters<'a, TSM> where
    TSM: SignatureMethod + Clone,  { /* private fields */ }

Represents OAuth parameters including oauth_nonce, oauth_timestamp, realm, and others.

Basic usage

use reqwest_oauth1::OAuthClientProvider;

let consumer_key = "[CONSUMER_KEY]";
let consumer_secret = "[CONSUMER_SECRET]";
let secrets = reqwest_oauth1::Secrets::new(consumer_key, consumer_secret);

let nonce = "[NONCE]";
let timestamp = 100_000_001u64;
let callback = "http://example.com/ready";

let params = reqwest_oauth1::OAuthParameters::new()
    .nonce(nonce)
    .timestamp(timestamp)
    .callback(callback);

let req = reqwest::Client::new()
    .oauth1_with_params(secrets, params)
    .post("http://example.com/")
    // and so on...
    ;

Note

You can specify same parameters as get/post queries and they will superseded with the specified one in the OAuthParameters.

use reqwest_oauth1::OAuthClientProvider;

let consumer_key = "[CONSUMER_KEY]";
let consumer_secret = "[CONSUMER_SECRET]";
let secrets = reqwest_oauth1::Secrets::new(consumer_key, consumer_secret);

let params = reqwest_oauth1::OAuthParameters::new()
    .nonce("ThisNonceWillBeSuperseded");
let req = reqwest::Client::new()
    .oauth1_with_params(secrets, params)
    .get("http://example.com/")
    .query(&[("nonce", "ThisNonceWillSupersedeTheOldOne")])
    // and so on...
    ;

Implementations

impl OAuthParameters<'_, HmacSha1>

pub fn new() -> Self

impl<'a, TSM> OAuthParameters<'a, TSM> where
    TSM: SignatureMethod + Clone, 

pub fn callback<T>(self, callback: T) -> Self where
    T: Into<Cow<'a, str>>, 

set the oauth_callback value

pub fn nonce<T>(self, nonce: T) -> Self where
    T: Into<Cow<'a, str>>, 

set the oauth_nonce value

pub fn realm<T>(self, realm: T) -> Self where
    T: Into<Cow<'a, str>>, 

set the realm value

Note

this parameter will not be included in the signature-base string. cf. https://tools.ietf.org/html/rfc5849#section-3.4.1.3.1

pub fn timestamp<T>(self, timestamp: T) -> Self where
    T: Into<u64>, 

set the oauth_timestamp value

pub fn verifier<T>(self, verifier: T) -> Self where
    T: Into<Cow<'a, str>>, 

set the oauth_verifier value

pub fn version<T>(self, version: T) -> Self where
    T: Into<bool>, 

set the oauth_version value (boolean)

Note

When the version has value true, oauth_version will be set with “1.0”. Otherwise, oauth_version will not be included in your request. In oauth1, oauth_version value must be “1.0” or not specified.

pub fn signature_method<T>(self, signature_method: T) -> OAuthParameters<'a, T> where
    T: SignatureMethod + Clone, 

Trait Implementations

impl<'a, TSM: Clone> Clone for OAuthParameters<'a, TSM> where
    TSM: SignatureMethod + Clone, 

fn clone(&self) -> OAuthParameters<'a, TSM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, TSM: Debug> Debug for OAuthParameters<'a, TSM> where
    TSM: SignatureMethod + Clone, 

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

Formats the value using the given formatter.

impl Default for OAuthParameters<'static, HmacSha1>

fn default() -> Self

Returns the “default value” for a type.