blob: 952fc7424c2f2c050338977d8d5ea8ae788bd1f4 [file] [view]
## Capabilities
Depending on its configuration and the backing system, this service can expose:
- [x] create_dir
- [x] stat
- [x] read
- [x] write
- [x] delete
- [x] list
- [x] copy
- [x] rename
- [ ] ~~presign~~
Inspect the effective capability set with [`opendal_core::Operator::info`] and
[`opendal_core::OperatorInfo::capability`] after building an operator.
## Configuration
Use [`crate::FsConfig`] 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
```rust,ignore
use std::sync::Arc;
use anyhow::Result;
use opendal::services::Fs;
use opendal::Operator;
#[tokio::main]
async fn main() -> Result<()> {
// Create fs backend builder.
let mut builder = Fs::default()
// Set the root for fs, all operations will happen under this root.
//
// NOTE: the root must be absolute path.
.root("/tmp");
let op: Operator = Operator::new(builder)?;
Ok(())
}
```