Struct OAuthRequestBuilder

pub struct OAuthRequestBuilder { /* private fields */ }

A builder for OAuthRequest

Implementations

impl OAuthRequestBuilder

pub fn new( request_uri: Uri, auth_level: AuthenticationLevel, signature_method: Box<dyn SignatureMethod>, ) -> Self

Returns a new OAuthRequestBuilder

The default settings are AuthorizationScheme::Header and no extra parameters.

pub fn add_parameters(self, parameters: &[Parameter]) -> Self

The parameters added here will be added as body or uri parameters, depending on the scheme

pub fn add_auth_parameters(self, parameters: &[Parameter]) -> Self

The parameters added with this will be added as headers if AuthorizationScheme::Header

Useful for adding the realm parameter if your use case requires it

pub fn scheme(self, scheme: AuthorizationScheme) -> Self

Sets the AuthorizationScheme to use

pub fn build(self) -> Result<OAuthRequest, Box<dyn Error>>

Attempts to create a request with the provided settings.

Notably, returns an error if there are any duplicated parameters. Can also return other errors, if for example signing the request fails.

Trait Implementations

impl Clone for OAuthRequestBuilder

fn clone(&self) -> OAuthRequestBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthRequestBuilder

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

Formats the value using the given formatter.