Struct Hooks 

pub struct Hooks { /* private fields */ }

Lifecycle hooks for the HTTP client.

Implementations

impl Hooks

pub fn new() -> Hooks

Creates an empty hook chain.

pub fn on_request<F, Fut>(self, f: F) -> Hooks

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

Runs before the transport call. Return Err(Error::hook("…")) to cancel the request.

Examples

use better_fetch::{ClientBuilder, Error, Hooks, Result};

let hooks = Hooks::new().on_request(|ctx| async move {
    if ctx.url.path().contains("blocked") {
        return Err(Error::hook("path not allowed"));
    }
    Ok(ctx)
});

let client = ClientBuilder::new()
    .base_url("https://api.example.com")?
    .hooks(hooks)
    .build()?;

pub fn on_response<F, Fut>(self, f: F) -> Hooks

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

Runs after the transport returns. Return Err(Error::hook("…")) to fail the request.

pub fn on_success<F, Fut>(self, f: F) -> Hooks

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

Runs after a successful (2xx) response; cannot abort the pipeline.

pub fn on_error<F, Fut>(self, f: F) -> Hooks

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

Runs when an error occurs; cannot abort the pipeline.

pub fn on_retry<F, Fut>(self, f: F) -> Hooks

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

Runs before a transport retry is scheduled.

Trait Implementations

impl Clone for Hooks

fn clone(&self) -> Hooks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Hooks

fn default() -> Hooks

Returns the “default value” for a type.