Trait Configurator

pub trait Configurator:
    Serialize
    + DeserializeOwned
    + Debug
    + 'static {
    type Builder: Builder;

    // Required method
    fn into_builder(self) -> Self::Builder;

    // Provided method
    fn from_iter(
        iter: impl IntoIterator<Item = (String, String)>,
    ) -> Result<Self> { ... }
}

Configurator is used to configure the underlying service.

This trait allows the developer to define a configuration struct that can:

• deserialize from an iterator like hashmap or vector.
• convert into a service builder and finally build the underlying services.

Usually, users don’t need to use or import this trait directly, they can use Operator API instead.

For example:

use std::collections::HashMap;

use opendal::services::MemoryConfig;
use opendal::Operator;
async fn test() -> Result<()> {
    let mut cfg = MemoryConfig::default();
    cfg.root = Some("/".to_string());

    // Build an `Operator` to start operating the storage.
    let op: Operator = Operator::from_config(cfg)?.finish();

    Ok(())
}

Some service builder might contain in memory options like http_client . Users can call into_builder to convert the configuration into a builder instead.

use std::collections::HashMap;

use opendal::raw::HttpClient;
use opendal::services::S3Config;
use opendal::Configurator;
use opendal::Operator;

async fn test() -> Result<()> {
    let mut cfg = S3Config::default();
    cfg.root = Some("/".to_string());
    cfg.bucket = "test".to_string();

    let builder = cfg.into_builder();
    let builder = builder.http_client(HttpClient::new()?);

    // Build an `Operator` to start operating the storage.
    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Required Associated Types

type Builder: Builder

Associated builder for this configuration.

Required Methods

fn into_builder(self) -> Self::Builder

Convert this configuration into a service builder.

Provided Methods

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

Deserialize from an iterator.

This API is provided by opendal, developer should not implement it.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Configurator for ()

type Builder = ()

fn into_builder(self) -> Self::Builder

Implementors

impl Configurator for AliyunDriveConfig

Available on crate feature services-aliyun-drive only.

type Builder = AliyunDriveBuilder

impl Configurator for AlluxioConfig

Available on crate feature services-alluxio only.

type Builder = AlluxioBuilder

impl Configurator for AtomicserverConfig

Available on crate feature services-atomicserver only.

type Builder = AtomicserverBuilder

impl Configurator for AzblobConfig

Available on crate feature services-azblob only.

type Builder = AzblobBuilder

impl Configurator for AzdlsConfig

Available on crate feature services-azdls only.

type Builder = AzdlsBuilder

impl Configurator for AzfileConfig

Available on crate feature services-azfile only.

type Builder = AzfileBuilder

impl Configurator for B2Config

Available on crate feature services-b2 only.

type Builder = B2Builder

impl Configurator for CacacheConfig

Available on crate feature services-cacache only.

type Builder = CacacheBuilder

impl Configurator for CloudflareKvConfig

Available on crate feature services-cloudflare-kv only.

type Builder = CloudflareKvBuilder

impl Configurator for CompfsConfig

Available on crate feature services-compfs only.

type Builder = CompfsBuilder

impl Configurator for CosConfig

Available on crate feature services-cos only.

type Builder = CosBuilder

impl Configurator for D1Config

Available on crate feature services-d1 only.

type Builder = D1Builder

impl Configurator for DashmapConfig

Available on crate feature services-dashmap only.

type Builder = DashmapBuilder

impl Configurator for DbfsConfig

Available on crate feature services-dbfs only.

type Builder = DbfsBuilder

impl Configurator for DropboxConfig

Available on crate feature services-dropbox only.

type Builder = DropboxBuilder

impl Configurator for EtcdConfig

Available on crate feature services-etcd only.

type Builder = EtcdBuilder

impl Configurator for FoundationdbConfig

Available on crate feature services-foundationdb only.

type Builder = FoundationdbBuilder

impl Configurator for FsConfig

Available on crate feature services-fs only.

type Builder = FsBuilder

impl Configurator for FtpConfig

Available on crate feature services-ftp only.

type Builder = FtpBuilder

impl Configurator for GcsConfig

Available on crate feature services-gcs only.

type Builder = GcsBuilder

impl Configurator for GdriveConfig

Available on crate feature services-gdrive only.

type Builder = GdriveBuilder

impl Configurator for GhacConfig

Available on crate feature services-ghac only.

type Builder = GhacBuilder

impl Configurator for GithubConfig

Available on crate feature services-github only.

type Builder = GithubBuilder

impl Configurator for GridfsConfig

Available on crate feature services-gridfs only.

type Builder = GridfsBuilder

impl Configurator for HdfsConfig

Available on crate feature services-hdfs only.

type Builder = HdfsBuilder

impl Configurator for HdfsNativeConfig

Available on crate feature services-hdfs-native only.

Hadoop Distributed File System (HDFS™) support. Using Native Rust HDFS client.

type Builder = HdfsNativeBuilder

impl Configurator for HttpConfig

Available on crate feature services-http only.

type Builder = HttpBuilder

impl Configurator for HuggingfaceConfig

Available on crate feature services-huggingface only.

type Builder = HuggingfaceBuilder

impl Configurator for IcloudConfig

Available on crate feature services-icloud only.

type Builder = IcloudBuilder

impl Configurator for IpfsConfig

Available on crate feature services-ipfs only.

type Builder = IpfsBuilder

impl Configurator for IpmfsConfig

Available on crate feature services-ipmfs only.

type Builder = IpmfsBuilder

impl Configurator for KoofrConfig

Available on crate feature services-koofr only.

type Builder = KoofrBuilder

impl Configurator for LakefsConfig

Available on crate feature services-lakefs only.

type Builder = LakefsBuilder

impl Configurator for MemcachedConfig

Available on crate feature services-memcached only.

type Builder = MemcachedBuilder

impl Configurator for MemoryConfig

Available on crate feature services-memory only.

type Builder = MemoryBuilder

impl Configurator for MiniMokaConfig

Available on crate feature services-mini-moka only.

type Builder = MiniMokaBuilder

impl Configurator for MokaConfig

Available on crate feature services-moka only.

type Builder = MokaBuilder

impl Configurator for MongodbConfig

Available on crate feature services-mongodb only.

type Builder = MongodbBuilder

impl Configurator for MonoiofsConfig

Available on crate feature services-monoiofs only.

type Builder = MonoiofsBuilder

impl Configurator for MysqlConfig

Available on crate feature services-mysql only.

type Builder = MysqlBuilder

impl Configurator for NebulaGraphConfig

Available on crate feature services-nebula-graph only.

type Builder = NebulaGraphBuilder

impl Configurator for ObsConfig

Available on crate feature services-obs only.

type Builder = ObsBuilder

impl Configurator for OnedriveConfig

Available on crate feature services-onedrive only.

type Builder = OnedriveBuilder

impl Configurator for OssConfig

Available on crate feature services-oss only.

type Builder = OssBuilder

impl Configurator for PcloudConfig

Available on crate feature services-pcloud only.

type Builder = PcloudBuilder

impl Configurator for PersyConfig

Available on crate feature services-persy only.

type Builder = PersyBuilder

impl Configurator for PostgresqlConfig

Available on crate feature services-postgresql only.

type Builder = PostgresqlBuilder

impl Configurator for RedbConfig

Available on crate feature services-redb only.

type Builder = RedbBuilder

impl Configurator for RedisConfig

Available on crate feature services-redis only.

type Builder = RedisBuilder

impl Configurator for RocksdbConfig

Available on crate feature services-rocksdb only.

type Builder = RocksdbBuilder

impl Configurator for S3Config

Available on crate feature services-s3 only.

type Builder = S3Builder

impl Configurator for SeafileConfig

Available on crate feature services-seafile only.

type Builder = SeafileBuilder

impl Configurator for SftpConfig

Available on crate feature services-sftp only.

type Builder = SftpBuilder

impl Configurator for SledConfig

Available on crate feature services-sled only.

type Builder = SledBuilder

impl Configurator for SqliteConfig

Available on crate feature services-sqlite only.

type Builder = SqliteBuilder

impl Configurator for SurrealdbConfig

Available on crate feature services-surrealdb only.

type Builder = SurrealdbBuilder

impl Configurator for SwiftConfig

Available on crate feature services-swift only.

type Builder = SwiftBuilder

impl Configurator for TikvConfig

Available on crate feature services-tikv only.

type Builder = TikvBuilder

impl Configurator for UpyunConfig

Available on crate feature services-upyun only.

type Builder = UpyunBuilder

impl Configurator for VercelArtifactsConfig

Available on crate feature services-vercel-artifacts only.

type Builder = VercelArtifactsBuilder

impl Configurator for VercelBlobConfig

Available on crate feature services-vercel-blob only.

type Builder = VercelBlobBuilder

impl Configurator for WebdavConfig

Available on crate feature services-webdav only.

type Builder = WebdavBuilder

impl Configurator for WebhdfsConfig

Available on crate feature services-webhdfs only.

type Builder = WebhdfsBuilder

impl Configurator for YandexDiskConfig

Available on crate feature services-yandex-disk only.

type Builder = YandexDiskBuilder