Skip to main content

SignedRequestBuilder

Struct SignedRequestBuilder 

Source
pub struct SignedRequestBuilder<'a, E, S>{ /* private fields */ }
Expand description

Generic builder for creating authenticated API requests.

This builder encapsulates the common workflow:

  1. Parameter building with fluent API
  2. Request signing via SigningStrategy
  3. HTTP execution via HasHttpClient

Implementations§

Source§

impl<'a, E, S> SignedRequestBuilder<'a, E, S>

Source

pub fn new(exchange: &'a E, strategy: S, endpoint: impl Into<String>) -> Self

Create a new signed request builder.

Source

pub fn method(self, method: HttpMethod) -> Self

Set the HTTP method (default: GET).

Source

pub fn param(self, key: impl Into<String>, value: &dyn ToString) -> Self

Add a required parameter.

Source

pub fn optional_param<T: ToString>( self, key: impl Into<String>, value: Option<T>, ) -> Self

Add an optional parameter (only if Some).

Source

pub fn params(self, params: BTreeMap<String, String>) -> Self

Add multiple parameters from a BTreeMap.

Source

pub fn body(self, body: Value) -> Self

Set the request body (for POST/PUT/DELETE).

Source

pub fn merge_json_params(self, params: Option<Value>) -> Self

Merge parameters from a JSON Value object.

Only string, number, and boolean values are supported. Nested objects and arrays are ignored.

Source

pub async fn execute(self) -> Result<Value>

Execute the signed request.

§Steps
  1. Create SigningContext from builder state
  2. Call strategy.prepare_request() to sign
  3. Build headers via strategy.add_auth_headers()
  4. Execute HTTP request via exchange.http_client()

Auto Trait Implementations§

§

impl<'a, E, S> Freeze for SignedRequestBuilder<'a, E, S>
where S: Freeze,

§

impl<'a, E, S> RefUnwindSafe for SignedRequestBuilder<'a, E, S>

§

impl<'a, E, S> Send for SignedRequestBuilder<'a, E, S>
where E: Sync,

§

impl<'a, E, S> Sync for SignedRequestBuilder<'a, E, S>
where E: Sync,

§

impl<'a, E, S> Unpin for SignedRequestBuilder<'a, E, S>
where S: Unpin,

§

impl<'a, E, S> UnwindSafe for SignedRequestBuilder<'a, E, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more