Struct Webdav 

pub struct Webdav { /* private fields */ }

Available on crate feature services-webdav only.

WebDAV backend support.

Capabilities

This service can be used to:

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

Notes

Bazel Remote Caching and Ccache HTTP Storage is also part of this service. Users can use webdav to connect those services.

Configuration

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

You can refer to WebdavBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal_service_webdav::Webdav;
use opendal_core::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Webdav::default()
        .endpoint("127.0.0.1")
        .username("xxx")
        .password("xxx");

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

    Ok(())
}

Implementations

impl WebdavBuilder

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

Set endpoint for http backend.

For example: https://example.com

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

set the username for Webdav

default: no username

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

set the password for Webdav

default: no password

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

set the bearer token for Webdav

default: no access token

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

Set root path of http backend.

pub fn enable_user_metadata(self, enable: bool) -> WebdavBuilder

Enable user metadata support via WebDAV PROPPATCH.

This feature requires the WebDAV server to support RFC4918 PROPPATCH method. Not all WebDAV servers support this (e.g., nginx’s basic WebDAV module doesn’t). Only enable this if your server supports PROPPATCH (e.g., Apache mod_dav, Nextcloud).

Default: false

pub fn user_metadata_prefix(self, prefix: &str) -> WebdavBuilder

Set the XML namespace prefix for user metadata properties.

This prefix is used in PROPPATCH/PROPFIND XML requests. Different servers may require different prefixes.

Default: “opendal”

pub fn user_metadata_uri(self, uri: &str) -> WebdavBuilder

Set the XML namespace URI for user metadata properties.

This URI uniquely identifies the namespace for custom properties. Different servers may require different namespace URIs.

Default: https://opendal.apache.org/ns

Trait Implementations

impl Builder for WebdavBuilder

type Config = WebdavConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Debug for WebdavBuilder

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

Formats the value using the given formatter.

impl Default for WebdavBuilder

fn default() -> WebdavBuilder

Returns the “default value” for a type.