Struct opendal::services::B2

pub struct B2 { /* private fields */ }

Available on crate feature services-b2 only.

b2 services support.

Capabilities

This service can be used to:

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

Configuration

• root: Set the work directory for backend
• key_id: B2 application key keyID
• application_key B2 application key applicationKey
• bucket B2 bucket name
• bucket_id B2 bucket_id

You can refer to B2Builder’s docs for more information

Example

Via Builder

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

#[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)?.finish();

    Ok(())
}

Implementations

impl B2Builder

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

Set root of this backend.

All operations will happen under this root.

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

application_key_id of this backend.

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

application_key of this backend.

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

Set bucket name of this backend. You can find it in https://secure.backblaze.com/b2_buckets.html

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

Set bucket id of this backend. You can find it in https://secure.backblaze.com/b2_buckets.html

pub fn http_client(self, client: HttpClient) -> 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 B2Builder

fn build(self) -> Result<impl Access>

Builds the backend and returns the result of B2Backend.

const SCHEME: Scheme = Scheme::B2

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

type Config = B2Config

Associated configuration for this builder.

impl Debug for B2Builder

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

Formats the value using the given formatter.

impl Default for B2Builder

fn default() -> B2Builder

Returns the “default value” for a type.