Struct HttpClientLayer

pub struct HttpClientLayer { /* private fields */ }

Layer for replacing the default HTTP client with a custom one.

This layer allows users to provide their own HTTP client implementation by implementing the HttpFetch trait. This is useful when you need to customize HTTP behavior, add authentication, use a different HTTP client library, or apply custom middleware.

Examples

use opendal::layers::HttpClientLayer;
use opendal::services;
use opendal::Operator;
use opendal::Result;
use opendal::raw::HttpClient;

// Create a custom HTTP client
let custom_client = HttpClient::new()?;

let op = Operator::new(services::S3::default())?
    .layer(HttpClientLayer::new(custom_client))
    .finish();

Custom HTTP Client Implementation

use opendal::raw::{HttpFetch, HttpBody};
use opendal::Buffer;
use http::{Request, Response};
use opendal::Result;

struct CustomHttpClient {
    // Your custom HTTP client fields
}

impl HttpFetch for CustomHttpClient {
    async fn fetch(&self, req: Request<Buffer>) -> Result<Response<HttpBody>> {
        // Your custom HTTP client implementation
        todo!()
    }
}

Implementations

impl HttpClientLayer

pub fn new(client: HttpClient) -> Self

Create a new HttpClientLayer with the given HTTP client.

Arguments

• client - The HTTP client to use for all HTTP requests

Examples

use opendal::layers::HttpClientLayer;
use opendal::raw::HttpClient;
use opendal::Result;

let client = HttpClient::new()?;
let layer = HttpClientLayer::new(client);

Trait Implementations

impl Clone for HttpClientLayer

fn clone(&self) -> HttpClientLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Access> Layer<A> for HttpClientLayer

type LayeredAccess = HttpClientAccessor<A>

The layered accessor that returned by this layer.

fn layer(&self, inner: A) -> Self::LayeredAccess

Intercept the operations on the underlying storage.