Struct opendal::services::Http

pub struct Http { /* private fields */ }

HTTP Read-only service support like Nginx and Caddy.

Capabilities

This service can be used to:

• read
• write
• list
• scan
• presign
• blocking

Notes

Only read ans stat are supported. We can use this service to visit any HTTP Server like nginx, caddy.

Configuration

• endpoint: set the endpoint for http
• root: Set the work directory for backend

You can refer to HttpBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::services::Http;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Http::default();

    builder.endpoint("127.0.0.1");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl HttpBuilder

pub fn endpoint(&mut self, endpoint: &str) -> &mut Self

Set endpoint for http backend.

For example: https://example.com

pub fn username(&mut self, username: &str) -> &mut Self

set password for http backend

default: no password

pub fn password(&mut self, password: &str) -> &mut Self

set password for http backend

default: no password

pub fn token(&mut self, token: &str) -> &mut Self

set bearer token for http backend

default: no access token

pub fn root(&mut self, root: &str) -> &mut Self

Set root path of http backend.

pub fn http_client(&mut self, client: HttpClient) -> &mut Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for HttpBuilder

const SCHEME: Scheme = Scheme::Http

Associated scheme for this builder.

type Accessor = HttpBackend

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

fn from_iter(iter: impl Iterator<Item = (String, String)>) -> Selfwhere
    Self: Sized,

Construct a builder from given iterator.

fn from_env() -> Selfwhere
    Self: Sized,

Construct a builder from envs.

impl Debug for HttpBuilder

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

Formats the value using the given formatter.

impl Default for HttpBuilder

fn default() -> HttpBuilder

Returns the “default value” for a type.