Enum Scheme

#[non_exhaustive]
pub enum Scheme {
    AliyunDrive,
    Atomicserver,
    Azblob,
    Azdls,
    B2,
    Compfs,
    Seafile,
    Upyun,
    VercelBlob,
    YandexDisk,
    Pcloud,
    Koofr,
    Cacache,
    CloudflareKv,
    Cos,
    D1,
    Dashmap,
    Etcd,
    Foundationdb,
    Dbfs,
    Fs,
    Ftp,
    Gcs,
    Ghac,
    Hdfs,
    Http,
    Huggingface,
    Alluxio,
    Ipfs,
    Ipmfs,
    Icloud,
    Memcached,
    Memory,
    MiniMoka,
    Moka,
    Monoiofs,
    Obs,
    Onedrive,
    Gdrive,
    Dropbox,
    Oss,
    Persy,
    Redis,
    Postgresql,
    Mysql,
    Sqlite,
    Rocksdb,
    S3,
    Sftp,
    Sled,
    Swift,
    VercelArtifacts,
    Webdav,
    Webhdfs,
    Redb,
    Tikv,
    Azfile,
    Mongodb,
    Gridfs,
    Github,
    HdfsNative,
    Surrealdb,
    Lakefs,
    NebulaGraph,
    Custom(&'static str),
}

Services that OpenDAL supports

Notes

• Scheme is non_exhaustive, new variant COULD be added at any time.
• New variant SHOULD be added in alphabet orders,
• Users MUST NOT relay on its order.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AliyunDrive

[aliyun_drive][crate::services::AliyunDrive]: Aliyun Drive services.

Atomicserver

[atomicserver][crate::services::Atomicserver]: Atomicserver services.

Azblob

azblob: Azure Storage Blob services.

Azdls

[Azdls][crate::services::Azdls]: Azure Data Lake Storage Gen2.

B2

[B2][crate::services::B2]: Backblaze B2 Services.

Compfs

[Compfs][crate::services::Compfs]: Compio fs Services.

Seafile

[Seafile][crate::services::Seafile]: Seafile Services.

Upyun

[Upyun][crate::services::Upyun]: Upyun Services.

VercelBlob

[VercelBlob][crate::services::VercelBlob]: VercelBlob Services.

YandexDisk

[YandexDisk][crate::services::YandexDisk]: YandexDisk Services.

Pcloud

[Pcloud][crate::services::Pcloud]: Pcloud Services.

Koofr

[Koofr][crate::services::Koofr]: Koofr Services.

Cacache

[cacache][crate::services::Cacache]: cacache backend support.

CloudflareKv

[cloudflare-kv][crate::services::CloudflareKv]: Cloudflare KV services.

Cos

[cos][crate::services::Cos]: Tencent Cloud Object Storage services.

D1

[d1][crate::services::D1]: D1 services

Dashmap

[dashmap][crate::services::Dashmap]: dashmap backend support.

Etcd

[etcd][crate::services::Etcd]: Etcd Services

Foundationdb

[foundationdb][crate::services::Foundationdb]: Foundationdb services.

Dbfs

[dbfs][crate::services::Dbfs]: DBFS backend support.

Fs

fs: POSIX-like file system.

Ftp

[ftp][crate::services::Ftp]: FTP backend.

Gcs

gcs: Google Cloud Storage backend.

Ghac

[ghac][crate::services::Ghac]: GitHub Action Cache services.

Hdfs

[hdfs][crate::services::Hdfs]: Hadoop Distributed File System.

Http

http: HTTP backend.

Huggingface

[huggingface][crate::services::Huggingface]: Huggingface services.

Alluxio

[alluxio][crate::services::Alluxio]: Alluxio services.

Ipfs

[ipmfs][crate::services::Ipfs]: IPFS HTTP Gateway

Ipmfs

[ipmfs][crate::services::Ipmfs]: IPFS mutable file system

Icloud

[icloud][crate::services::Icloud]: APPLE icloud services.

Memcached

[memcached][crate::services::Memcached]: Memcached service support.

Memory

memory: In memory backend support.

MiniMoka

[mini-moka][crate::services::MiniMoka]: Mini Moka backend support.

Moka

[moka][crate::services::Moka]: moka backend support.

Monoiofs

[monoiofs][crate::services::Monoiofs]: monoio fs services.

Obs

[obs][crate::services::Obs]: Huawei Cloud OBS services.

Onedrive

[onedrive][crate::services::Onedrive]: Microsoft OneDrive services.

Gdrive

[gdrive][crate::services::Gdrive]: GoogleDrive services.

Dropbox

[dropbox][crate::services::Dropbox]: Dropbox services.

Oss

oss: Aliyun Object Storage Services

Persy

[persy][crate::services::Persy]: persy backend support.

Redis

[redis][crate::services::Redis]: Redis services

Postgresql

[postgresql][crate::services::Postgresql]: Postgresql services

Mysql

[mysql][crate::services::Mysql]: Mysql services

Sqlite

[sqlite][crate::services::Sqlite]: Sqlite services

Rocksdb

[rocksdb][crate::services::Rocksdb]: RocksDB services

S3

s3: AWS S3 alike services.

Sftp

[sftp][crate::services::Sftp]: SFTP services

Sled

[sled][crate::services::Sled]: Sled services

Swift

[swift][crate::services::Swift]: Swift backend support.

VercelArtifacts

[Vercel Artifacts][crate::services::VercelArtifacts]: Vercel Artifacts service, as known as Vercel Remote Caching.

Webdav

[webdav][crate::services::Webdav]: WebDAV support.

Webhdfs

[webhdfs][crate::services::Webhdfs]: WebHDFS RESTful API Services

Redb

[redb][crate::services::Redb]: Redb Services

Tikv

[tikv][crate::services::Tikv]: Tikv Services

Azfile

[azfile][crate::services::Azfile]: Azfile Services

Mongodb

mongodb: MongoDB Services

Gridfs

gridfs: MongoDB Gridfs Services

Github

[Github Contents][crate::services::Github]: Github contents support.

HdfsNative

Native HDFS: Hdfs Native service, using rust hdfs-native client for hdfs

Surrealdb

surrealdb: Surrealdb Services

Lakefs

lakefs: LakeFS Services

NebulaGraph

NebulaGraph: NebulaGraph Services

Custom(&'static str)

Custom that allow users to implement services outside OpenDAL.

NOTE

• Custom must not overwrite any existing services name.
• Custom must be in lower case.

Implementations

impl Scheme

pub fn into_static(self) -> &'static str

Convert self into static str.

pub fn enabled() -> HashSet<Scheme>

Get all enabled schemes.

OpenDAL could be compiled with different features, which will enable different schemes. This function returns all enabled schemes so users can make decisions based on it.

Examples

use opendal::Scheme;

let enabled_schemes = Scheme::enabled();
if !enabled_schemes.contains(&Scheme::Memory) {
    panic!("s3 support is not enabled")
}

Trait Implementations

impl Clone for Scheme

fn clone(&self) -> Scheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scheme

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

Formats the value using the given formatter.

impl Default for Scheme

fn default() -> Scheme

Returns the “default value” for a type.

impl Display for Scheme

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

Formats the value using the given formatter.

impl From<Scheme> for &'static str

fn from(v: Scheme) -> &'static str

Converts to this type from the input type.

impl From<Scheme> for String

fn from(v: Scheme) -> String

Converts to this type from the input type.

impl FromStr for Scheme

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Scheme, <Scheme as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Scheme

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Scheme

fn eq(&self, other: &Scheme) -> 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 Copy for Scheme

impl Eq for Scheme

impl StructuralPartialEq for Scheme