Struct opendal::services::Azdfs

pub struct Azdfs { /* private fields */ }

Azure Data Lake Storage Gen2 Support.

As known as abfs, azdfs or azdls.

This service will visist the ABFS URI supported by Azure Data Lake Storage Gen2.

Capabilities

This service can be used to:

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

Configuration

• root: Set the work dir for backend.
• filesystem: Set the filesystem name for backend.
• endpoint: Set the endpoint for backend.
• account_name: Set the account_name for backend.
• account_key: Set the account_key for backend.

Refer to public API docs for more information.

Example

Init OpenDAL Operator

Via Builder

use std::sync::Arc;

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

#[tokio::main]
async fn main() -> Result<()> {
    // Create azblob backend builder.
    let mut builder = Azdfs::default();
    // Set the root for azblob, all operations will happen under this root.
    //
    // NOTE: the root must be absolute path.
    builder.root("/path/to/dir");
    // Set the filesystem name, this is required.
    builder.filesystem("test");
    // Set the endpoint, this is required.
    //
    // For examples:
    // - "https://accountname.dfs.core.windows.net"
    builder.endpoint("https://accountname.dfs.core.windows.net");
    // Set the account_name and account_key.
    //
    // OpenDAL will try load credential from the env.
    // If credential not set and no valid credential in env, OpenDAL will
    // send request without signing like anonymous user.
    builder.account_name("account_name");
    builder.account_key("account_key");

    // `Accessor` provides the low level APIs, we will use `Operator` normally.
    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Implementations

impl AzdfsBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set filesystem name of this backend.

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

Set endpoint of this backend.

Endpoint must be full uri, e.g.

• Azblob: https://accountname.blob.core.windows.net
• Azurite: http://127.0.0.1:10000/devstoreaccount1

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

Set account_name of this backend.

• If account_name is set, we will take user’s input first.
• If not, we will try to load it from environment.

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

Set account_key of this backend.

• If account_key is set, we will take user’s input first.
• If not, we will try to load it from environment.

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 AzdfsBuilder

type Accessor = AzdfsBackend

The accessor that built by this builder.

const SCHEME: Scheme = Scheme::Azdfs

Associated scheme for this builder.

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

Consume the accessor builder to build a service.

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

Construct a builder from given map.

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 Clone for AzdfsBuilder

fn clone(&self) -> AzdfsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AzdfsBuilder

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

Formats the value using the given formatter.

impl Default for AzdfsBuilder

fn default() -> AzdfsBuilder

Returns the “default value” for a type.