Struct EndpointRequestBuilder 

pub struct EndpointRequestBuilder<'a, E, S>
where
    E: Endpoint,
{ /* private fields */ }

Fluent builder for a typed Endpoint.

When E::Params is not [()], the builder starts in NeedsParams and requires .params() before .send_json().

Implementations

impl<'a, E> EndpointRequestBuilder<'a, E, NeedsParams>

where E: Endpoint,

pub fn params( self, params: <E as Endpoint>::Params, ) -> EndpointRequestBuilder<'a, E, Ready>

Applies typed path parameters for E::Params and transitions to Ready.

impl<'a, E> EndpointRequestBuilder<'a, E, Ready>

where E: Endpoint,

pub fn query( self, query: <E as Endpoint>::Query, ) -> EndpointRequestBuilder<'a, E, Ready>

Applies typed query parameters for E::Query.

pub fn header( self, key: impl AsRef<str>, value: impl AsRef<str>, ) -> Result<EndpointRequestBuilder<'a, E, Ready>, Error>

Adds a request header.

pub fn bearer_token( self, token: impl Into<String>, ) -> EndpointRequestBuilder<'a, E, Ready>

Sets bearer authentication.

pub fn cancellation_token( self, token: CancellationToken, ) -> EndpointRequestBuilder<'a, E, Ready>

Attaches a cancellation token.

pub fn throw_on_error(self, throw: bool) -> EndpointRequestBuilder<'a, E, Ready>

When true, send returns Err on non-2xx.

pub async fn send(self) -> Result<Response, Error>

Executes the request and returns Response.

pub async fn send_json(self) -> Result<<E as Endpoint>::Response, Error>

Executes and deserializes E::Response (feature json).

pub fn into_inner(self) -> RequestBuilder<'a>

Returns the underlying RequestBuilder for advanced options.