Struct oauth_1a::OAuthData

pub struct OAuthData {
    pub client_id: ClientId,
    pub token: Option<Token>,
    pub signature_method: SignatureMethod,
    pub nonce: Nonce,
}

The main entrypoint to the API. Non-sensitive data required for all authenticated requests.

Fields

client_id: ClientId

The client ID.

token: Option<Token>

The OAuth token.

signature_method: SignatureMethod

The signature method.

nonce: Nonce

The nonce.

Implementations

impl OAuthData

#[must_use]pub fn authorization(
    &self,
    req: SignableRequest,
    typ: AuthorizationType,
    key: &SigningKey
) -> String

Generate an HTTP Authorization header.

#[must_use]pub fn parameters(&self) -> BTreeMap<String, String>

Get the OAuth parameters.

pub fn regen_nonce(&mut self)

Regenerate the nonce. This should be done at least between each identical request made within a second.

Trait Implementations

impl Debug for OAuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuthData

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

Deserialize this value from the given Serde deserializer.

impl Eq for OAuthData

impl Hash for OAuthData

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 Ord for OAuthData

fn cmp(&self, other: &OAuthData) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<OAuthData> for OAuthData

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

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

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

This method tests for !=.

impl PartialOrd<OAuthData> for OAuthData

fn partial_cmp(&self, other: &OAuthData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &OAuthData) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &OAuthData) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &OAuthData) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &OAuthData) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OAuthData

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

Serialize this value into the given Serde serializer.

impl StructuralEq for OAuthData

impl StructuralPartialEq for OAuthData