Struct HttpRequest 

#[non_exhaustive]
pub struct HttpRequest {
    pub method: Method,
    pub url: String,
    pub headers: HeaderMap,
    pub body: Bytes,
    pub timeout: Duration,
    pub connect_timeout: Option<Duration>,
    pub max_response_bytes: usize,
}

One outbound HTTP request.

Construct with HttpRequest::get / HttpRequest::post / HttpRequest::new and refine with the builder methods. The struct is #[non_exhaustive], so fields can be added without breaking callers; reading the fields from an implementation stays fine.

Bounds are per-request rather than per-transport because the three call sites differ: a JWKS fetch at startup can afford a longer deadline than a token exchange sitting in a request’s critical path.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

method: Method

Request method.

url: String

Absolute request URL, including scheme.

A String rather than a parsed type so this crate takes no opinion on URL parsing. Implementations parse with whatever their stack already uses, and an unparseable URL surfaces as HttpTransportError::InvalidRequest.

headers: HeaderMap

Request headers. Host is the implementation’s to set, since it derives from the URL and from any connection reuse the transport performs.

body: Bytes

Request body. Empty for a bodyless method.

timeout: Duration

Overall deadline covering connect and I/O. Exceeding it is HttpTransportError::Timeout.

connect_timeout: Option<Duration>

Bound on connection establishment alone. None leaves it to the implementation.

A hint rather than a guarantee. A transport that pools connections configures the connect bound once for the pool, so a per-request value it cannot apply is ignored — the bundled hyper transport does exactly this. timeout is the bound that always holds, and it covers the connect phase, so ignoring this one shortens no deadline and loses no safety.

Set it when the caller wants connect to fail faster than the overall deadline would allow, and treat honoring it as a bonus.

max_response_bytes: usize

Ceiling on the buffered response body. Exceeding it is HttpTransportError::ResponseTooLarge rather than a truncated body, because a truncated JWKS document is indistinguishable from a malformed one.

Implementations

impl HttpRequest

pub fn new(method: Method, url: impl Into<String>) -> HttpRequest

A request with the given method and URL, carrying the default bounds and no headers or body.

pub fn get(url: impl Into<String>) -> HttpRequest

A GET for url.

pub fn post(url: impl Into<String>, body: Bytes) -> HttpRequest

A POST to url carrying body.

pub fn header( self, name: impl AsRef<str>, value: impl AsRef<str>, ) -> Result<HttpRequest, HttpTransportError>

Set a header, replacing any existing value for that name.

Errors

Returns HttpTransportError::InvalidRequest when the name or value is not a legal header. Taking the error here rather than panicking matters because both can come from operator config.

pub fn body(self, body: Bytes) -> HttpRequest

Replace the request body.

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

Set the overall deadline.

pub fn connect_timeout(self, timeout: Duration) -> HttpRequest

Set the connect bound.

pub fn max_response_bytes(self, max: usize) -> HttpRequest

Set the response body ceiling.

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequest

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

Formats the value using the given formatter.