Skip to main content

Http

Struct Http 

Source
pub struct Http { /* private fields */ }
Expand description

HTTP Read-only service support like Nginx and Caddy.

§Capabilities

Depending on its configuration and the backing system, this service can expose:

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

Inspect the effective capability set with opendal_core::Operator::info and opendal_core::OperatorInfo::capability after building an operator.

§Notes

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

§Configuration

Use crate::HttpConfig for serializable configuration and this builder’s methods for direct construction. The field and method documentation defines accepted values, defaults, and environment interaction.

§Example

§Via Builder

use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_http::Http;

#[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)?;
    Ok(())
}

Implementations§

Source§

impl HttpBuilder

Source

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

Set endpoint for http backend.

For example: https://example.com

Source

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

set username for http backend

default: no username

Source

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

set password for http backend

default: no password

Source

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

set bearer token for http backend

default: no access token

Source

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

Set root path of http backend.

Trait Implementations§

Source§

impl Builder for HttpBuilder

Source§

type Config = HttpConfig

Associated configuration.
Source§

fn build(self) -> Result<impl Service>

Consume the builder to build a service.
Source§

impl Debug for HttpBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HttpBuilder

Source§

fn default() -> HttpBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.