Trait Builder

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

    // 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 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

type Config = ()

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

Implementors

impl Builder for AliyunDriveBuilder

Available on crate feature services-aliyun-drive only.

type Config = AliyunDriveConfig

impl Builder for AlluxioBuilder

Available on crate feature services-alluxio only.

type Config = AlluxioConfig

impl Builder for AzblobBuilder

Available on crate feature services-azblob only.

type Config = AzblobConfig

impl Builder for AzdlsBuilder

Available on crate feature services-azdls only.

type Config = AzdlsConfig

impl Builder for AzfileBuilder

Available on crate feature services-azfile only.

type Config = AzfileConfig

impl Builder for B2Builder

Available on crate feature services-b2 only.

type Config = B2Config

impl Builder for CacacheBuilder

Available on crate feature services-cacache only.

type Config = CacacheConfig

impl Builder for CloudflareKvBuilder

Available on crate feature services-cloudflare-kv only.

type Config = CloudflareKvConfig

impl Builder for CompfsBuilder

Available on crate feature services-compfs only.

type Config = CompfsConfig

impl Builder for CosBuilder

Available on crate feature services-cos only.

type Config = CosConfig

impl Builder for D1Builder

Available on crate feature services-d1 only.

type Config = D1Config

impl Builder for DashmapBuilder

Available on crate feature services-dashmap only.

type Config = DashmapConfig

impl Builder for DbfsBuilder

Available on crate feature services-dbfs only.

type Config = DbfsConfig

impl Builder for DropboxBuilder

Available on crate feature services-dropbox only.

type Config = DropboxConfig

impl Builder for EtcdBuilder

Available on crate feature services-etcd only.

type Config = EtcdConfig

impl Builder for FoundationdbBuilder

Available on crate feature services-foundationdb only.

type Config = FoundationdbConfig

impl Builder for FsBuilder

Available on crate feature services-fs only.

type Config = FsConfig

impl Builder for FtpBuilder

Available on crate feature services-ftp only.

type Config = FtpConfig

impl Builder for GcsBuilder

Available on crate feature services-gcs only.

type Config = GcsConfig

impl Builder for GdriveBuilder

Available on crate feature services-gdrive only.

type Config = GdriveConfig

impl Builder for GhacBuilder

Available on crate feature services-ghac only.

type Config = GhacConfig

impl Builder for GithubBuilder

Available on crate feature services-github only.

type Config = GithubConfig

impl Builder for GridfsBuilder

Available on crate feature services-gridfs only.

type Config = GridfsConfig

impl Builder for HdfsBuilder

Available on crate feature services-hdfs only.

type Config = HdfsConfig

impl Builder for HdfsNativeBuilder

Available on crate feature services-hdfs-native only.

type Config = HdfsNativeConfig

impl Builder for HttpBuilder

Available on crate feature services-http only.

type Config = HttpConfig

impl Builder for HuggingfaceBuilder

Available on crate feature services-huggingface only.

type Config = HuggingfaceConfig

impl Builder for IpfsBuilder

Available on crate feature services-ipfs only.

type Config = IpfsConfig

impl Builder for IpmfsBuilder

Available on crate feature services-ipmfs only.

type Config = IpmfsConfig

impl Builder for KoofrBuilder

Available on crate feature services-koofr only.

type Config = KoofrConfig

impl Builder for LakefsBuilder

Available on crate feature services-lakefs only.

type Config = LakefsConfig

impl Builder for MemcachedBuilder

Available on crate feature services-memcached only.

type Config = MemcachedConfig

impl Builder for MemoryBuilder

Available on crate feature services-memory only.

type Config = MemoryConfig

impl Builder for MiniMokaBuilder

Available on crate feature services-mini-moka only.

type Config = MiniMokaConfig

impl Builder for MokaBuilder

Available on crate feature services-moka only.

type Config = MokaConfig

impl Builder for MongodbBuilder

Available on crate feature services-mongodb only.

type Config = MongodbConfig

impl Builder for MonoiofsBuilder

Available on crate feature services-monoiofs only.

type Config = MonoiofsConfig

impl Builder for MysqlBuilder

Available on crate feature services-mysql only.

type Config = MysqlConfig

impl Builder for ObsBuilder

Available on crate feature services-obs only.

type Config = ObsConfig

impl Builder for OnedriveBuilder

Available on crate feature services-onedrive only.

type Config = OnedriveConfig

impl Builder for OssBuilder

Available on crate feature services-oss only.

type Config = OssConfig

impl Builder for PcloudBuilder

Available on crate feature services-pcloud only.

type Config = PcloudConfig

impl Builder for PersyBuilder

Available on crate feature services-persy only.

type Config = PersyConfig

impl Builder for PostgresqlBuilder

Available on crate feature services-postgresql only.

type Config = PostgresqlConfig

impl Builder for RedbBuilder

Available on crate feature services-redb only.

type Config = RedbConfig

impl Builder for RedisBuilder

Available on crate feature services-redis only.

type Config = RedisConfig

impl Builder for RocksdbBuilder

Available on crate feature services-rocksdb only.

type Config = RocksdbConfig

impl Builder for S3Builder

Available on crate feature services-s3 only.

type Config = S3Config

impl Builder for SeafileBuilder

Available on crate feature services-seafile only.

type Config = SeafileConfig

impl Builder for SftpBuilder

Available on crate feature services-sftp only.

type Config = SftpConfig

impl Builder for SledBuilder

Available on crate feature services-sled only.

type Config = SledConfig

impl Builder for SqliteBuilder

Available on crate feature services-sqlite only.

type Config = SqliteConfig

impl Builder for SurrealdbBuilder

Available on crate feature services-surrealdb only.

type Config = SurrealdbConfig

impl Builder for SwiftBuilder

Available on crate feature services-swift only.

type Config = SwiftConfig

impl Builder for TikvBuilder

Available on crate feature services-tikv only.

type Config = TikvConfig

impl Builder for UpyunBuilder

Available on crate feature services-upyun only.

type Config = UpyunConfig

impl Builder for VercelArtifactsBuilder

Available on crate feature services-vercel-artifacts only.

type Config = VercelArtifactsConfig

impl Builder for VercelBlobBuilder

Available on crate feature services-vercel-blob only.

type Config = VercelBlobConfig

impl Builder for WebdavBuilder

Available on crate feature services-webdav only.

type Config = WebdavConfig

impl Builder for WebhdfsBuilder

Available on crate feature services-webhdfs only.

type Config = WebhdfsConfig

impl Builder for YandexDiskBuilder

Available on crate feature services-yandex-disk only.

type Config = YandexDiskConfig