Trait opendal::Builder

pub trait Builder: Default {
    type Accessor: Accessor;

    const SCHEME: Scheme;

    // Required methods
    fn from_map(map: HashMap<String, String>) -> Self;
    fn build(&mut self) -> Result<Self::Accessor>;
}

Builder is used to set up a real underlying service, i.e. storage accessor.

One builder is usually used by Operator during its initialization. It can be created by accepting several k-v pairs from one HashMap, one iterator and specific environment variables.

By default each builder of underlying service must support deriving from one HashMap. Besides that, according to the implementation, each builder will have its own special methods to control the behavior of initialization of the underlying service. It often provides semantic interface instead of using dynamic k-v strings directly. Because the latter way is obscure and hard to remember how many parameters it will have.

So it is recommended that developer should read related doc of builder carefully when you are working with one service. We also promise that every public API will provide detailed documentation.

It’s recommended to use Operator::new to avoid use Builder trait directly.

Required Associated Types

type Accessor: Accessor

The accessor that built by this builder.

Required Associated Constants

const SCHEME: Scheme

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

Required Methods

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map which contains several parameters needed by underlying service.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Builder for ()

Dummy implementation of builder

const SCHEME: Scheme = _

type Accessor = ()

fn from_map(_: HashMap<String, String>) -> Self

fn build(&mut self) -> Result<Self::Accessor>

Implementors

impl Builder for AlluxioBuilder

Available on crate feature services-alluxio only.

const SCHEME: Scheme = Scheme::Alluxio

type Accessor = AlluxioBackend

impl Builder for AtomicserverBuilder

Available on crate feature services-atomicserver only.

const SCHEME: Scheme = Scheme::Atomicserver

type Accessor = Backend<Adapter>

impl Builder for AzblobBuilder

Available on crate feature services-azblob only.

const SCHEME: Scheme = Scheme::Azblob

type Accessor = AzblobBackend

impl Builder for AzdlsBuilder

Available on crate feature services-azdls only.

type Accessor = AzdlsBackend

const SCHEME: Scheme = Scheme::Azdls

impl Builder for AzfileBuilder

Available on crate feature services-azfile only.

const SCHEME: Scheme = Scheme::Azfile

type Accessor = AzfileBackend

impl Builder for B2Builder

Available on crate feature services-b2 only.

const SCHEME: Scheme = Scheme::B2

type Accessor = B2Backend

impl Builder for CacacheBuilder

Available on crate feature services-cacache only.

const SCHEME: Scheme = Scheme::Cacache

type Accessor = Backend<Adapter>

impl Builder for ChainsafeBuilder

Available on crate feature services-chainsafe only.

const SCHEME: Scheme = Scheme::Chainsafe

type Accessor = ChainsafeBackend

impl Builder for CloudflareKvBuilder

Available on crate feature services-cloudflare-kv only.

const SCHEME: Scheme = Scheme::CloudflareKv

type Accessor = Backend<Adapter>

impl Builder for CosBuilder

Available on crate feature services-cos only.

const SCHEME: Scheme = Scheme::Cos

type Accessor = CosBackend

impl Builder for D1Builder

Available on crate feature services-d1 only.

const SCHEME: Scheme = Scheme::D1

type Accessor = Backend<Adapter>

impl Builder for DashmapBuilder

Available on crate feature services-dashmap only.

const SCHEME: Scheme = Scheme::Dashmap

type Accessor = Backend<Adapter>

impl Builder for DbfsBuilder

Available on crate feature services-dbfs only.

const SCHEME: Scheme = Scheme::Dbfs

type Accessor = DbfsBackend

impl Builder for DropboxBuilder

Available on crate feature services-dropbox only.

const SCHEME: Scheme = Scheme::Dropbox

type Accessor = DropboxBackend

impl Builder for EtcdBuilder

Available on crate feature services-etcd only.

const SCHEME: Scheme = Scheme::Etcd

type Accessor = Backend<Adapter>

impl Builder for FoundationdbBuilder

Available on crate feature services-foundationdb only.

const SCHEME: Scheme = Scheme::Foundationdb

type Accessor = Backend<Adapter>

impl Builder for FsBuilder

Available on crate feature services-fs only.

const SCHEME: Scheme = Scheme::Fs

type Accessor = FsBackend

impl Builder for FtpBuilder

Available on crate feature services-ftp only.

const SCHEME: Scheme = Scheme::Ftp

type Accessor = FtpBackend

impl Builder for GcsBuilder

Available on crate feature services-gcs only.

const SCHEME: Scheme = Scheme::Gcs

type Accessor = GcsBackend

impl Builder for GdriveBuilder

Available on crate feature services-gdrive only.

const SCHEME: Scheme = Scheme::Gdrive

type Accessor = GdriveBackend

impl Builder for GhacBuilder

Available on crate feature services-ghac only.

const SCHEME: Scheme = Scheme::Ghac

type Accessor = GhacBackend

impl Builder for GithubBuilder

Available on crate feature services-github only.

const SCHEME: Scheme = Scheme::Github

type Accessor = GithubBackend

impl Builder for GridFsBuilder

Available on crate feature services-gridfs only.

const SCHEME: Scheme = Scheme::Mongodb

type Accessor = Backend<Adapter>

impl Builder for HdfsBuilder

Available on crate feature services-hdfs only.

const SCHEME: Scheme = Scheme::Hdfs

type Accessor = HdfsBackend

impl Builder for HdfsNativeBuilder

Available on crate feature services-hdfs-native only.

const SCHEME: Scheme = Scheme::HdfsNative

type Accessor = HdfsNativeBackend

impl Builder for HttpBuilder

Available on crate feature services-http only.

const SCHEME: Scheme = Scheme::Http

type Accessor = HttpBackend

impl Builder for HuggingfaceBuilder

Available on crate feature services-huggingface only.

const SCHEME: Scheme = Scheme::Huggingface

type Accessor = HuggingfaceBackend

impl Builder for IcloudBuilder

Available on crate feature services-icloud only.

const SCHEME: Scheme = Scheme::Icloud

type Accessor = IcloudBackend

impl Builder for IpfsBuilder

Available on crate feature services-ipfs only.

const SCHEME: Scheme = Scheme::Ipfs

type Accessor = IpfsBackend

impl Builder for IpmfsBuilder

Available on crate feature services-ipmfs only.

const SCHEME: Scheme = Scheme::Ipmfs

type Accessor = IpmfsBackend

impl Builder for KoofrBuilder

Available on crate feature services-koofr only.

const SCHEME: Scheme = Scheme::Koofr

type Accessor = KoofrBackend

impl Builder for LibsqlBuilder

Available on crate feature services-libsql only.

const SCHEME: Scheme = Scheme::Libsql

type Accessor = Backend<Adapter>

impl Builder for MemcachedBuilder

Available on crate feature services-memcached only.

const SCHEME: Scheme = Scheme::Memcached

type Accessor = Backend<Adapter>

impl Builder for MemoryBuilder

Available on crate feature services-memory only.

const SCHEME: Scheme = Scheme::Memory

type Accessor = Backend<Adapter>

impl Builder for MiniMokaBuilder

Available on crate feature services-mini-moka only.

const SCHEME: Scheme = Scheme::MiniMoka

type Accessor = Backend<Adapter>

impl Builder for MokaBuilder

Available on crate feature services-moka only.

const SCHEME: Scheme = Scheme::Moka

type Accessor = Backend<Adapter>

impl Builder for MongodbBuilder

Available on crate feature services-mongodb only.

const SCHEME: Scheme = Scheme::Mongodb

type Accessor = Backend<Adapter>

impl Builder for MysqlBuilder

Available on crate feature services-mysql only.

const SCHEME: Scheme = Scheme::Mysql

type Accessor = Backend<Adapter>

impl Builder for ObsBuilder

Available on crate feature services-obs only.

const SCHEME: Scheme = Scheme::Obs

type Accessor = ObsBackend

impl Builder for OnedriveBuilder

Available on crate feature services-onedrive only.

const SCHEME: Scheme = Scheme::Onedrive

type Accessor = OnedriveBackend

impl Builder for OssBuilder

Available on crate feature services-oss only.

const SCHEME: Scheme = Scheme::Oss

type Accessor = OssBackend

impl Builder for PcloudBuilder

Available on crate feature services-pcloud only.

const SCHEME: Scheme = Scheme::Pcloud

type Accessor = PcloudBackend

impl Builder for PersyBuilder

Available on crate feature services-persy only.

const SCHEME: Scheme = Scheme::Persy

type Accessor = Backend<Adapter>

impl Builder for PostgresqlBuilder

Available on crate feature services-postgresql only.

const SCHEME: Scheme = Scheme::Postgresql

type Accessor = Backend<Adapter>

impl Builder for RedbBuilder

Available on crate feature services-redb only.

const SCHEME: Scheme = Scheme::Redb

type Accessor = Backend<Adapter>

impl Builder for RedisBuilder

Available on crate feature services-redis only.

const SCHEME: Scheme = Scheme::Redis

type Accessor = Backend<Adapter>

impl Builder for RocksdbBuilder

Available on crate feature services-rocksdb only.

const SCHEME: Scheme = Scheme::Rocksdb

type Accessor = Backend<Adapter>

impl Builder for S3Builder

Available on crate feature services-s3 only.

const SCHEME: Scheme = Scheme::S3

type Accessor = S3Backend

impl Builder for SeafileBuilder

Available on crate feature services-seafile only.

const SCHEME: Scheme = Scheme::Seafile

type Accessor = SeafileBackend

impl Builder for SftpBuilder

Available on crate feature services-sftp only.

const SCHEME: Scheme = Scheme::Sftp

type Accessor = SftpBackend

impl Builder for SledBuilder

Available on crate feature services-sled only.

const SCHEME: Scheme = Scheme::Sled

type Accessor = Backend<Adapter>

impl Builder for SqliteBuilder

Available on crate feature services-sqlite only.

const SCHEME: Scheme = Scheme::Sqlite

type Accessor = Backend<Adapter>

impl Builder for SupabaseBuilder

Available on crate feature services-supabase only.

const SCHEME: Scheme = Scheme::Supabase

type Accessor = SupabaseBackend

impl Builder for SurrealdbBuilder

Available on crate feature services-surrealdb only.

const SCHEME: Scheme = Scheme::Surrealdb

type Accessor = Backend<Adapter>

impl Builder for SwiftBuilder

Available on crate feature services-swift only.

const SCHEME: Scheme = Scheme::Swift

type Accessor = SwiftBackend

impl Builder for TikvBuilder

Available on crate feature services-tikv only.

const SCHEME: Scheme = Scheme::Tikv

type Accessor = Backend<Adapter>

impl Builder for UpyunBuilder

Available on crate feature services-upyun only.

const SCHEME: Scheme = Scheme::Upyun

type Accessor = UpyunBackend

impl Builder for VercelArtifactsBuilder

Available on crate feature services-vercel-artifacts only.

const SCHEME: Scheme = Scheme::VercelArtifacts

type Accessor = VercelArtifactsBackend

impl Builder for VercelBlobBuilder

Available on crate feature services-vercel-blob only.

const SCHEME: Scheme = Scheme::VercelBlob

type Accessor = VercelBlobBackend

impl Builder for WebdavBuilder

Available on crate feature services-webdav only.

const SCHEME: Scheme = Scheme::Webdav

type Accessor = WebdavBackend

impl Builder for WebhdfsBuilder

Available on crate feature services-webhdfs only.

const SCHEME: Scheme = Scheme::Webhdfs

type Accessor = WebhdfsBackend

impl Builder for YandexDiskBuilder

Available on crate feature services-yandex-disk only.

const SCHEME: Scheme = Scheme::YandexDisk

type Accessor = YandexDiskBackend