Struct opendal::services::Azfile

pub struct Azfile { /* private fields */ }

Available on crate feature services-azfile only.

Azure File services support.

Capabilities

This service can be used to:

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

Configuration

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

Refer to public API docs for more information.

Example

Via Builder

use std::sync::Arc;

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

#[tokio::main]
async fn main() -> Result<()> {
  // Create azfile backend builder.
  let mut builder = Azfile::default();
  // Set the root for azfile, 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.share_name("test");
  // Set the endpoint, this is required.
  //
  // For examples:
  // - "https://accountname.file.core.windows.net"
  builder.endpoint("https://accountname.file.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 AzfileBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set endpoint of this backend.

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 share_name(&mut self, share_name: &str) -> &mut Self

Set file share name of this backend.

Notes

You can find more about from: https://learn.microsoft.com/en-us/rest/api/storageservices/operations-on-shares--file-service

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 AzfileBuilder

const SCHEME: Scheme = Scheme::Azfile

Associated scheme for this builder. It indicates what underlying service is.

type Accessor = AzfileBackend

The accessor that built by this builder.

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

Construct a builder from given map which contains several parameters needed by underlying service.

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

Consume the accessor builder to build a service.

impl Clone for AzfileBuilder

fn clone(&self) -> AzfileBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AzfileBuilder

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

Formats the value using the given formatter.

impl Default for AzfileBuilder

fn default() -> AzfileBuilder

Returns the “default value” for a type.