Struct Obs 

pub struct Obs { /* private fields */ }

Available on crate feature services-obs only.

Huawei-Cloud Object Storage Service (OBS) support

Capabilities

This service can be used to:

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

Configuration

• root: Set the work directory for backend
• bucket: Set the container name for backend
• endpoint: Customizable endpoint setting
• access_key_id: Set the access_key_id for backend.
• secret_access_key: Set the secret_access_key for backend.

You can refer to ObsBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal_core::Operator;
use opendal_service_obs::Obs;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Obs::default()
        // set the storage bucket for OpenDAL
        .bucket("test")
        .endpoint("obs.cn-north-1.myhuaweicloud.com")
        // Set the access_key_id and secret_access_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.
        .access_key_id("access_key_id")
        .secret_access_key("secret_access_key");

    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Implementations

impl ObsBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set endpoint of this backend.

Both huaweicloud default domain and user domain endpoints are allowed. Please DO NOT add the bucket name to the endpoint.

• https://obs.cn-north-4.myhuaweicloud.com
• obs.cn-north-4.myhuaweicloud.com (https by default)
• https://custom.obs.com (port should not be set)

pub fn access_key_id(self, access_key_id: &str) -> ObsBuilder

Set access_key_id of this backend.

• If it is set, we will take user’s input first.
• If not, we will try to load it from environment.

pub fn secret_access_key(self, secret_access_key: &str) -> ObsBuilder

Set secret_access_key of this backend.

• If it is set, we will take user’s input first.
• If not, we will try to load it from environment.

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

Set bucket of this backend. The param is required.

pub fn enable_versioning(self, enabled: bool) -> ObsBuilder

Set bucket versioning status for this backend

Trait Implementations

impl Builder for ObsBuilder

type Config = ObsConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Debug for ObsBuilder

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

Formats the value using the given formatter.

impl Default for ObsBuilder

fn default() -> ObsBuilder

Returns the “default value” for a type.