Struct oauth1_request::Request

pub struct Request {
    pub authorization: String,
    pub data: String,
}

A pair of an OAuth header and its corresponding query/form string.

Fields

authorization: String

The Authorization header string for the request.

data: String

The URI with query string or the x-www-form-urlencoded string for the request.

Methods

impl Request

pub fn new<'a, SM: SignatureMethod>(
    method: &str,
    uri: impl Display,
    consumer_key: &str,
    consumer_secret: &str,
    token_secret: impl Into<Option<&'a str>>,
    signature_method: SM,
    options: impl Into<Option<&'a Options<'a>>>,
    params: Option<&BTreeSet<(impl Borrow<str>, impl Borrow<str>)>>
) -> Self

Deprecated since 0.2.1:

Use <Option<&BTreeSet<(impl Borrow<str>, impl Borrow<str>)>> as OAuth1Authorize>::authorize instead

Convenience method for creating a Request using Signer::new.

Example

extern crate oauth1_request as oauth;

let oauth::Request { authorization, data } = oauth::Request::new(
    "GET",
    "https://example.com/api/v1/get.json",
    "consumer_key",
    "consumer_secret",
    "token_secret",
    oauth::HmacSha1,
    &*oauth::Options::new().token("token"),
    Some(&[("key", "value")].iter().cloned().collect()),
);

pub fn new_form<'a, SM: SignatureMethod>(
    method: &str,
    uri: impl Display,
    consumer_key: &str,
    consumer_secret: &str,
    token_secret: impl Into<Option<&'a str>>,
    signature_method: SM,
    options: impl Into<Option<&'a Options<'a>>>,
    params: Option<&BTreeSet<(impl Borrow<str>, impl Borrow<str>)>>
) -> Self

Deprecated since 0.2.1:

Use <Option<&BTreeSet<(impl Borrow<str>, impl Borrow<str>)>> as OAuth1Authorize>::authorize_form instead

Convenience method for creating a Request using Signer::new_form.

Example

extern crate oauth1_request as oauth;

let oauth::Request { authorization, data } = oauth::Request::new(
    "POST",
    "https://example.com/api/v1/post.json",
    "consumer_key",
    "consumer_secret",
    "token_secret",
    oauth::HmacSha1,
    &*oauth::Options::new().token("token"),
    Some(&[("key", "value")].iter().cloned().collect()),
);

pub fn signer<'a, SM: SignatureMethod>(
    method: &str,
    uri: impl Display,
    consumer_secret: &str,
    token_secret: impl Into<Option<&'a str>>,
    signature_method: SM
) -> Signer<SM, NotReady>

Alias of Signer::with_signature_method for convenience.

pub fn signer_form<'a, SM: SignatureMethod>(
    method: &str,
    uri: impl Display,
    consumer_secret: &str,
    token_secret: impl Into<Option<&'a str>>,
    signature_method: SM
) -> Signer<SM, NotReady>

Alias of Signer::form_with_signature_method for convenience.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Request> for Request

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

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

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

This method tests for !=.

impl Eq for Request

impl Hash for Request

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Request

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

Formats the value using the given formatter.