Struct opendal::services::Cos

pub struct Cos { /* private fields */ }

Available on crate feature services-cos only.

Tencent-Cloud COS 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
• 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 CosBuilder’s docs for more information

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Cos::default()
        // set the storage bucket for OpenDAL
        .bucket("test")
        // set the endpoint for OpenDAL
        .endpoint("https://cos.ap-singapore.myqcloud.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.
        .secret_id("secret_id")
        .secret_key("secret_access_key");

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

    Ok(())
}

Implementations

impl CosBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set endpoint of this backend.

NOTE: no bucket or account id in endpoint, we will trim them if exists.

Examples

• https://cos.ap-singapore.myqcloud.com

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

Set secret_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_key(self, secret_key: &str) -> Self

Set secret_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) -> Self

Set bucket of this backend. The param is required.

pub fn disable_config_load(self) -> Self

Disable config load so that opendal will not load config from environment.

For examples:

• envs like TENCENTCLOUD_SECRET_ID

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 CosBuilder

const SCHEME: Scheme = Scheme::Cos

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

type Config = CosConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Clone for CosBuilder

fn clone(&self) -> CosBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CosBuilder

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

Formats the value using the given formatter.

impl Default for CosBuilder

fn default() -> CosBuilder

Returns the “default value” for a type.