Skip to main content

Crate opendal_service_http

Crate opendal_service_http 

Source
Expand description

§Apache OpenDAL™ HTTP Service

opendal-service-http provides access to objects over HTTP and HTTPS for applications built with Apache OpenDAL™.

§Use through opendal

Applications should normally enable this service through the opendal facade with the services-http feature:

cargo add opendal --features services-http

The service is available as opendal::services::Http. Configure the service builder, then pass it to opendal::Operator::new.

§Use with opendal-core

Add the split crates directly:

cargo add opendal-core opendal-service-http

Pass a configured service builder to Operator::new:

use opendal_core::{Operator, OperatorRegistry, Result};
use opendal_service_http::{register_http_service, Http};

fn build_operator(builder: Http) -> Result<Operator> {
    Operator::new(builder)
}

fn register_for_uri() {
    register_http_service(OperatorRegistry::get());
}

register_for_uri is only needed for scheme-driven construction through Operator::from_uri or Operator::via_iter.

Services that send HTTP requests also require an HTTP transport in OperationContext. See the opendal-core composition example.

§Documentation

§License

Licensed under the Apache License, Version 2.0.

Structs§

Http
HTTP Read-only service support like Nginx and Caddy.
HttpConfig
Config for Http service support.

Constants§

HTTPS_SCHEME
Alias URI scheme used for HTTPS connections.
HTTP_SCHEME
URI scheme used for service registration and scheme-driven construction.

Functions§

register_http_service
Register this service’s URI scheme or schemes with an operator registry.