Struct HttpRequestFactory 

pub struct HttpRequestFactory { /* private fields */ }

Available on crate features middleware and _api only.

Cheaply cloneable request factory used to rebuild a request on demand.

This is the key boundary for middleware support:

• the client captures the request inputs once
• tower layers may clone the factory freely
• retries rebuild the request instead of trying to clone an already-built reqwest::Request

The Arc is intentional. tower::retry needs to be able to clone the request handle without forcing the payload itself to be eagerly copied. The factory handle is cheap to clone; the request is only rebuilt when build() is actually called.

Implementations

impl HttpRequestFactory

pub fn new<F, Fut>(make_request: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Request, OpenAIError>> + Send + 'static,

Available on non-target_family=wasm only.

Create a replayable request factory from an async request builder.

The closure is stored behind an Arc so this value stays cheap to clone when it is passed through tower layers.

pub async fn build(&self) -> Result<Request, OpenAIError>

Rebuild the request for the current attempt.

This is what makes retries possible for non-cloneable bodies. The request is not cloned after construction; instead, the original request inputs are replayed to produce a fresh reqwest::Request each time.

Trait Implementations

impl Clone for HttpRequestFactory

fn clone(&self) -> HttpRequestFactory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequestFactory

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

Formats the value using the given formatter.

impl Policy<HttpRequestFactory, Response, OpenAIError> for SimpleRetryPolicy

type Future = Pin<Box<dyn Future<Output = ()> + Send>>

The Future type returned by Policy::retry.

fn retry( &mut self, _req: &mut HttpRequestFactory, result: &mut Result<Response, OpenAIError>, ) -> Option<Self::Future>

Check the policy if a certain request should be retried.

fn clone_request( &mut self, req: &HttpRequestFactory, ) -> Option<HttpRequestFactory>

Tries to clone a request before being passed to the inner service.

impl<S> Service<HttpRequestFactory> for OpenAIRetry<S>

where S: Service<HttpRequestFactory, Response = Response, Error = OpenAIError> + Clone + Send + 'static, S::Future: Send + 'static,

Available on non-target_family=wasm only.

type Response = Response

Responses given by the service.

type Error = OpenAIError

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<Response, OpenAIError>> + Send>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: HttpRequestFactory) -> Self::Future

Process the request and return the response asynchronously.

impl Service<HttpRequestFactory> for ReqwestService

type Response = Response

Responses given by the service.

type Error = OpenAIError

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<Response, OpenAIError>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: HttpRequestFactory) -> Self::Future

Process the request and return the response asynchronously.