Struct TosConfig 

#[non_exhaustive]
pub struct TosConfig {
    pub root: Option<String>,
    pub bucket: String,
    pub endpoint: Option<String>,
    pub region: Option<String>,
    pub access_key_id: Option<String>,
    pub secret_access_key: Option<String>,
    pub security_token: Option<String>,
    pub disable_config_load: bool,
    pub allow_anonymous: bool,
    pub enable_versioning: bool,
}

Available on crate feature services-tos only.

Config for Volcengine TOS service.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

root: Option<String>

root of this backend.

All operations will happen under this root.

default to / if not set.

bucket: String

bucket name of this backend.

required.

endpoint: Option<String>

endpoint of this backend.

Endpoint must be full uri, e.g.

• TOS: https://tos-cn-beijing.volces.com
• TOS with region: https://tos-{region}.volces.com

If user inputs endpoint without scheme like “tos-cn-beijing.volces.com”, we will prepend “https://” before it.

region: Option<String>

Region represent the signing region of this endpoint.

Required if endpoint is not provided.

• If region is set, we will take user’s input first.
• If not, we will try to load it from environment.
• If still not set, default to cn-beijing.

access_key_id: Option<String>

access_key_id of this backend.

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

secret_access_key: Option<String>

secret_access_key of this backend.

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

security_token: Option<String>

security_token of this backend.

This token will expire after sometime, it’s recommended to set security_token by hand.

disable_config_load: bool

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

For examples:

• envs like TOS_ACCESS_KEY_ID

allow_anonymous: bool

Allow anonymous will allow opendal to send request without signing when credential is not loaded.

enable_versioning: bool

Enable bucket versioning for this backend.

If set to true, OpenDAL will support versioned operations like list with versions, read with version, etc.

Trait Implementations

impl Clone for TosConfig

fn clone(&self) -> TosConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurator for TosConfig

type Builder = TosBuilder

Associated builder for this configuration.

fn from_uri(uri: &OperatorUri) -> Result<TosConfig, Error>

Build configuration from a parsed URI plus merged options.

fn into_builder(self) -> <TosConfig as Configurator>::Builder

Convert this configuration into a service builder.

fn from_iter( iter: impl IntoIterator<Item = (String, String)>, ) -> Result<Self, Error>

Deserialize from an iterator.

impl Debug for TosConfig

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

Formats the value using the given formatter.

impl Default for TosConfig

fn default() -> TosConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TosConfig

where TosConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<TosConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TosConfig

fn eq(&self, other: &TosConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TosConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TosConfig

impl StructuralPartialEq for TosConfig