Struct RequestBuilder 

pub struct RequestBuilder { /* private fields */ }

Prepares a Request without sending it.

Implementations

impl RequestBuilder

pub fn method<M>(self, method: M) -> Self

where M: TryInto<Method>,

The request method. Defaults to GET.

Takes a Method or anything that converts into one; a value that does not is reported where the builder resolves.

pub fn header<N, V>(self, name: N, value: V) -> Self

where N: TryInto<HeaderName>, V: TryInto<HeaderValue>,

Set a header, replacing whatever any layer beneath contributed for that name.

Takes HeaderName and HeaderValue or anything that converts into them.

pub fn headers<N, V>(self, headers: impl IntoIterator<Item = (N, V)>) -> Self

where N: TryInto<HeaderName>, V: TryInto<HeaderValue>,

Set several headers, each applied as a single header would be.

pub fn remove_header<N>(self, name: N) -> Self

where N: TryInto<HeaderName>,

Remove a header, including whatever the layers beneath contributed for it.

pub fn body(self, body: impl Into<Bytes>) -> Self

A body already in hand.

pub fn body_stream( self, body: impl Stream<Item = Result<Bytes>> + Send + 'static, ) -> Self

A body arriving in chunks, which goes out chunked having no length to declare.

pub fn timeout(self, timeout: Duration) -> Self

Bound the whole request and response.

pub fn integrity(self, integrity: impl Into<String>) -> Self

The digests the response body is expected to match.

pub fn compress(self, coding: impl Into<String>) -> Self

Available on crate feature encoding only.

Compress the request body in this coding, named by its wire token.

pub fn cache(self, mode: CacheMode) -> Self

Available on crate feature cache only.

How the HTTP cache is consulted for this request.

pub fn credentials(self, credentials: Credentials) -> Self

Whether the request carries its credentials.

pub fn priority(self, priority: Priority) -> Self

How this request ranks against others, as an RFC 9218 urgency.

impl RequestBuilder

pub fn build(self) -> Result<Request, FaithError>

Settle the layers into a request.

A conversion that failed on the way in — an unparseable target, say — is reported here.