blob: 6d4ae7f63ec4c2591ca0ff109820dcfce077ca51 [file] [view]
## Capabilities
Depending on its configuration and the backing system, this service can expose:
- [ ] create_dir
- [x] stat
- [x] read
- [x] write
- [x] delete
- [x] list
- [x] copy
- [ ] rename
- [x] presign
Inspect the effective capability set with [`opendal_core::Operator::info`] and
[`opendal_core::OperatorInfo::capability`] after building an operator.
## Configuration
Use [`crate::B2Config`] 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,no_run
use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_b2::B2;
#[tokio::main]
async fn main() -> Result<()> {
// create backend builder
let mut builder = B2::default()
// set the storage bucket for OpenDAL
.root("/")
// set the key_id for OpenDAL
.application_key_id("xxxxxxxxxx")
// set the key_id for OpenDAL
.application_key("xxxxxxxxxx")
// set the bucket name for OpenDAL
.bucket("opendal")
// set the bucket_id for OpenDAL
.bucket_id("xxxxxxxxxxxxx");
let op: Operator = Operator::new(builder)?;
Ok(())
}
```