Trait Builder

pub trait Builder: Default + 'static {
    type Config: Configurator;

    const SCHEME: Scheme;

    // Required method
    fn build(self) -> Result<impl Access>;
}

Builder is used to set up underlying services.

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

• build a service via builder style API.
• configure in-memory options like http_client or customized_credential_load.

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

For example:

use opendal::services::Fs;
use opendal::Operator;
async fn test() -> Result<()> {
    // Create fs backend builder.
    let mut builder = Fs::default().root("/tmp");

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

    Ok(())
}

Required Associated Constants

const SCHEME: Scheme

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

Required Associated Types

type Config: Configurator

Associated configuration for this builder.

Required Methods

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

Consume the accessor builder to build a service.

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 Builder for ()

Dummy implementation of builder

const SCHEME: Scheme

type Config = ()

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

Implementors

impl Builder for AliyunDriveBuilder

Available on crate feature services-aliyun-drive only.

const SCHEME: Scheme = Scheme::AliyunDrive

type Config = AliyunDriveConfig

impl Builder for AlluxioBuilder

Available on crate feature services-alluxio only.

const SCHEME: Scheme = Scheme::Alluxio

type Config = AlluxioConfig

impl Builder for AtomicserverBuilder

Available on crate feature services-atomicserver only.

const SCHEME: Scheme = Scheme::Atomicserver

type Config = AtomicserverConfig

impl Builder for AzblobBuilder

Available on crate feature services-azblob only.

const SCHEME: Scheme = Scheme::Azblob

type Config = AzblobConfig

impl Builder for AzdlsBuilder

Available on crate feature services-azdls only.

const SCHEME: Scheme = Scheme::Azdls

type Config = AzdlsConfig

impl Builder for AzfileBuilder

Available on crate feature services-azfile only.

const SCHEME: Scheme = Scheme::Azfile

type Config = AzfileConfig

impl Builder for B2Builder

Available on crate feature services-b2 only.

const SCHEME: Scheme = Scheme::B2

type Config = B2Config

impl Builder for CacacheBuilder

Available on crate feature services-cacache only.

const SCHEME: Scheme = Scheme::Cacache

type Config = CacacheConfig

impl Builder for CloudflareKvBuilder

Available on crate feature services-cloudflare-kv only.

const SCHEME: Scheme = Scheme::CloudflareKv

type Config = CloudflareKvConfig

impl Builder for CompfsBuilder

Available on crate feature services-compfs only.

const SCHEME: Scheme = Scheme::Compfs

type Config = CompfsConfig

impl Builder for CosBuilder

Available on crate feature services-cos only.

const SCHEME: Scheme = Scheme::Cos

type Config = CosConfig

impl Builder for D1Builder

Available on crate feature services-d1 only.

const SCHEME: Scheme = Scheme::D1

type Config = D1Config

impl Builder for DashmapBuilder

Available on crate feature services-dashmap only.

const SCHEME: Scheme = Scheme::Dashmap

type Config = DashmapConfig

impl Builder for DbfsBuilder

Available on crate feature services-dbfs only.

const SCHEME: Scheme = Scheme::Dbfs

type Config = DbfsConfig

impl Builder for DropboxBuilder

Available on crate feature services-dropbox only.

const SCHEME: Scheme = Scheme::Dropbox

type Config = DropboxConfig

impl Builder for EtcdBuilder

Available on crate feature services-etcd only.

const SCHEME: Scheme = Scheme::Etcd

type Config = EtcdConfig

impl Builder for FoundationdbBuilder

Available on crate feature services-foundationdb only.

const SCHEME: Scheme = Scheme::Foundationdb

type Config = FoundationdbConfig

impl Builder for FsBuilder

Available on crate feature services-fs only.

const SCHEME: Scheme = Scheme::Fs

type Config = FsConfig

impl Builder for FtpBuilder

Available on crate feature services-ftp only.

const SCHEME: Scheme = Scheme::Ftp

type Config = FtpConfig

impl Builder for GcsBuilder

Available on crate feature services-gcs only.

const SCHEME: Scheme = Scheme::Gcs

type Config = GcsConfig

impl Builder for GdriveBuilder

Available on crate feature services-gdrive only.

const SCHEME: Scheme = Scheme::Gdrive

type Config = GdriveConfig

impl Builder for GhacBuilder

Available on crate feature services-ghac only.

const SCHEME: Scheme = Scheme::Ghac

type Config = GhacConfig

impl Builder for GithubBuilder

Available on crate feature services-github only.

const SCHEME: Scheme = Scheme::Github

type Config = GithubConfig

impl Builder for GridfsBuilder

Available on crate feature services-gridfs only.

const SCHEME: Scheme = Scheme::Gridfs

type Config = GridfsConfig

impl Builder for HdfsBuilder

Available on crate feature services-hdfs only.

const SCHEME: Scheme = Scheme::Hdfs

type Config = HdfsConfig

impl Builder for HdfsNativeBuilder

Available on crate feature services-hdfs-native only.

const SCHEME: Scheme = Scheme::HdfsNative

type Config = HdfsNativeConfig

impl Builder for HttpBuilder

Available on crate feature services-http only.

const SCHEME: Scheme = Scheme::Http

type Config = HttpConfig

impl Builder for HuggingfaceBuilder

Available on crate feature services-huggingface only.

const SCHEME: Scheme = Scheme::Huggingface

type Config = HuggingfaceConfig

impl Builder for IcloudBuilder

Available on crate feature services-icloud only.

const SCHEME: Scheme = Scheme::Icloud

type Config = IcloudConfig

impl Builder for IpfsBuilder

Available on crate feature services-ipfs only.

const SCHEME: Scheme = Scheme::Ipfs

type Config = IpfsConfig

impl Builder for IpmfsBuilder

Available on crate feature services-ipmfs only.

const SCHEME: Scheme = Scheme::Ipmfs

type Config = IpmfsConfig

impl Builder for KoofrBuilder

Available on crate feature services-koofr only.

const SCHEME: Scheme = Scheme::Koofr

type Config = KoofrConfig

impl Builder for LakefsBuilder

Available on crate feature services-lakefs only.

const SCHEME: Scheme = Scheme::Lakefs

type Config = LakefsConfig

impl Builder for MemcachedBuilder

Available on crate feature services-memcached only.

const SCHEME: Scheme = Scheme::Memcached

type Config = MemcachedConfig

impl Builder for MemoryBuilder

Available on crate feature services-memory only.

const SCHEME: Scheme = Scheme::Memory

type Config = MemoryConfig

impl Builder for MiniMokaBuilder

Available on crate feature services-mini-moka only.

const SCHEME: Scheme = Scheme::MiniMoka

type Config = MiniMokaConfig

impl Builder for MokaBuilder

Available on crate feature services-moka only.

const SCHEME: Scheme = Scheme::Moka

type Config = MokaConfig

impl Builder for MongodbBuilder

Available on crate feature services-mongodb only.

const SCHEME: Scheme = Scheme::Mongodb

type Config = MongodbConfig

impl Builder for MonoiofsBuilder

Available on crate feature services-monoiofs only.

const SCHEME: Scheme = Scheme::Monoiofs

type Config = MonoiofsConfig

impl Builder for MysqlBuilder

Available on crate feature services-mysql only.

const SCHEME: Scheme = Scheme::Mysql

type Config = MysqlConfig

impl Builder for NebulaGraphBuilder

Available on crate feature services-nebula-graph only.

const SCHEME: Scheme = Scheme::NebulaGraph

type Config = NebulaGraphConfig

impl Builder for ObsBuilder

Available on crate feature services-obs only.

const SCHEME: Scheme = Scheme::Obs

type Config = ObsConfig

impl Builder for OnedriveBuilder

Available on crate feature services-onedrive only.

const SCHEME: Scheme = Scheme::Onedrive

type Config = OnedriveConfig

impl Builder for OssBuilder

Available on crate feature services-oss only.

const SCHEME: Scheme = Scheme::Oss

type Config = OssConfig

impl Builder for PcloudBuilder

Available on crate feature services-pcloud only.

const SCHEME: Scheme = Scheme::Pcloud

type Config = PcloudConfig

impl Builder for PersyBuilder

Available on crate feature services-persy only.

const SCHEME: Scheme = Scheme::Persy

type Config = PersyConfig

impl Builder for PostgresqlBuilder

Available on crate feature services-postgresql only.

const SCHEME: Scheme = Scheme::Postgresql

type Config = PostgresqlConfig

impl Builder for RedbBuilder

Available on crate feature services-redb only.

const SCHEME: Scheme = Scheme::Redb

type Config = RedbConfig

impl Builder for RedisBuilder

Available on crate feature services-redis only.

const SCHEME: Scheme = Scheme::Redis

type Config = RedisConfig

impl Builder for RocksdbBuilder

Available on crate feature services-rocksdb only.

const SCHEME: Scheme = Scheme::Rocksdb

type Config = RocksdbConfig

impl Builder for S3Builder

Available on crate feature services-s3 only.

const SCHEME: Scheme = Scheme::S3

type Config = S3Config

impl Builder for SeafileBuilder

Available on crate feature services-seafile only.

const SCHEME: Scheme = Scheme::Seafile

type Config = SeafileConfig

impl Builder for SftpBuilder

Available on crate feature services-sftp only.

const SCHEME: Scheme = Scheme::Sftp

type Config = SftpConfig

impl Builder for SledBuilder

Available on crate feature services-sled only.

const SCHEME: Scheme = Scheme::Sled

type Config = SledConfig

impl Builder for SqliteBuilder

Available on crate feature services-sqlite only.

const SCHEME: Scheme = Scheme::Sqlite

type Config = SqliteConfig

impl Builder for SurrealdbBuilder

Available on crate feature services-surrealdb only.

const SCHEME: Scheme = Scheme::Surrealdb

type Config = SurrealdbConfig

impl Builder for SwiftBuilder

Available on crate feature services-swift only.

const SCHEME: Scheme = Scheme::Swift

type Config = SwiftConfig

impl Builder for TikvBuilder

Available on crate feature services-tikv only.

const SCHEME: Scheme = Scheme::Tikv

type Config = TikvConfig

impl Builder for UpyunBuilder

Available on crate feature services-upyun only.

const SCHEME: Scheme = Scheme::Upyun

type Config = UpyunConfig

impl Builder for VercelArtifactsBuilder

Available on crate feature services-vercel-artifacts only.

const SCHEME: Scheme = Scheme::VercelArtifacts

type Config = VercelArtifactsConfig

impl Builder for VercelBlobBuilder

Available on crate feature services-vercel-blob only.

const SCHEME: Scheme = Scheme::VercelBlob

type Config = VercelBlobConfig

impl Builder for WebdavBuilder

Available on crate feature services-webdav only.

const SCHEME: Scheme = Scheme::Webdav

type Config = WebdavConfig

impl Builder for WebhdfsBuilder

Available on crate feature services-webhdfs only.

const SCHEME: Scheme = Scheme::Webhdfs

type Config = WebhdfsConfig

impl Builder for YandexDiskBuilder

Available on crate feature services-yandex-disk only.

const SCHEME: Scheme = Scheme::YandexDisk

type Config = YandexDiskConfig