blob: 3f769df3871a3e0c70399747f6ba73adfebb62b7 [file] [view]
## Capabilities
This service can be used to:
- [x] create_dir
- [x] stat
- [x] read
- [x] write
- [x] delete
- [x] list
- [ ] copy
- [x] rename
- [ ] presign
## 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
```rust,no_run
use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_azfile::Azfile;
#[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.
.root("/path/to/dir")
// Set the filesystem name, this is required.
.share_name("test")
// Set the endpoint, this is required.
//
// For examples:
// - "https://accountname.file.core.windows.net"
.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.
.account_name("account_name")
.account_key("account_key");
// `Accessor` provides the low level APIs, we will use `Operator` normally.
let op: Operator = Operator::new(builder)?.finish();
Ok(())
}
```