Struct oauth1_request::serializer::auth::Authorizer

pub struct Authorizer<'a, SM: SignatureMethod, W = String> { /* private fields */ }

A Serializer that signs a request and produces OAuth 1.0 oauth_* parameter values.

The resulting parameter values are either written to an HTTP Authorization header value or URI query/x-www-form-urlencoded string (along with the other request parameters) depending on the constructor you use.

Implementations

impl<'a, SM: SignatureMethod> Authorizer<'a, SM>

pub fn authorization<T: Display>(
    method: &str,
    uri: T,
    client: Credentials<&'a str>,
    token: Option<Credentials<&'a str>>,
    options: &'a Options<'a>,
    signature_method: SM
) -> Self

Available on crate feature alloc only.

Creates an Authorizer that produces an HTTP `Authorization header value.

uri must not contain a query part. Otherwise, the serializer will produce a wrong signature.

Panics

In debug builds, panics if uri contains a '?' character.

pub fn form<T: Display>(
    method: &str,
    uri: T,
    client: Credentials<&'a str>,
    token: Option<Credentials<&'a str>>,
    options: &'a Options<'a>,
    signature_method: SM
) -> Self

Available on crate feature alloc only.

Creates an Authorizer that produces an x-www-form-urlencoded string.

uri must not contain a query part. Otherwise, the serializer will produce a wrong signature.

Panics

In debug builds, panics if uri contains a '?' character.

impl<'a, SM: SignatureMethod, W: Write> Authorizer<'a, SM, W>

pub fn query(
    method: &str,
    uri: W,
    client: Credentials<&'a str>,
    token: Option<Credentials<&'a str>>,
    options: &'a Options<'a>,
    signature_method: SM
) -> Self where
    W: Display, 

Creates an Authorizer that appends a query part to uri.

uri must not contain a query part. Otherwise, the serializer will produce a wrong signature.

Panics

In debug builds, panics if uri contains a '?' character.

pub fn authorization_with_buf<T: Display>(
    buf: W,
    method: &str,
    uri: T,
    client: Credentials<&'a str>,
    token: Option<Credentials<&'a str>>,
    options: &'a Options<'a>,
    signature_method: SM
) -> Self

Same as authorization except that this writes the resulting Authorization header value into buf.

pub fn form_with_buf<T: Display>(
    buf: W,
    method: &str,
    uri: T,
    client: Credentials<&'a str>,
    token: Option<Credentials<&'a str>>,
    options: &'a Options<'a>,
    signature_method: SM
) -> Self

Same with form except that this writes the resulting form string into buf.

Trait Implementations

impl<'a, SM: Clone + SignatureMethod, W: Clone> Clone for Authorizer<'a, SM, W> where
    SM::Sign: Clone, 

fn clone(&self) -> Authorizer<'a, SM, W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, SM: Debug + SignatureMethod, W: Debug> Debug for Authorizer<'a, SM, W> where
    SM::Sign: Debug, 

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

Formats the value using the given formatter.

impl<'a, SM: SignatureMethod, W: Write> Serializer for Authorizer<'a, SM, W>

type Output = W

The type of the value produced by this serializer.

fn serialize_parameter<V: Display>(&mut self, key: &str, value: V)

Serializes a key-value pair.

fn serialize_parameter_encoded<V: Display>(&mut self, key: &str, value: V)

Serializes a key-value pair.

fn serialize_oauth_callback(&mut self)

Appends oauth_callback parameter to the Authorization header.

fn serialize_oauth_consumer_key(&mut self)

Appends oauth_consumer_key parameter to the Authorization header.

fn serialize_oauth_nonce(&mut self)

Appends oauth_nonce parameter to the Authorization header.

fn serialize_oauth_signature_method(&mut self)

Appends oauth_signature_method parameter to the Authorization header.

fn serialize_oauth_timestamp(&mut self)

Appends oauth_timestamp parameter to the Authorization header.

fn serialize_oauth_token(&mut self)

Appends oauth_token parameter to the Authorization header.

fn serialize_oauth_verifier(&mut self)

Appends oauth_verifier parameter to the Authorization header.

fn serialize_oauth_version(&mut self)

Appends oauth_version parameter to the Authorization header.

fn end(self) -> W

Finalizes the serialization and returns the serialized value.