Struct Http

pub struct Http {
    config: HttpConfig,
    http_client: Option<HttpClient>,
}

HTTP Read-only service support like Nginx and Caddy.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• presign
• blocking

Notes

Only read and 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 http backend builder
    let mut builder = Http::default().endpoint("127.0.0.1");

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

Fields

config: HttpConfig

http_client: Option<HttpClient>

Implementations

impl HttpBuilder

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

Set endpoint for http backend.

For example: https://example.com

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

set username for http backend

default: no username

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

set password for http backend

default: no password

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

set bearer token for http backend

default: no access token

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

Set root path of http backend.

pub fn http_client(self, client: HttpClient) -> HttpBuilder

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. It indicates what underlying service is.

type Config = HttpConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access, Error>

Consume the accessor builder to build a service.

impl Debug for HttpBuilder

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

Formats the value using the given formatter.

impl Default for HttpBuilder

fn default() -> HttpBuilder

Returns the “default value” for a type.