Enum Scheme

Source
#[non_exhaustive]
pub enum Scheme {
Show 65 variants 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),
}
Expand description

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)§

This enum is marked as 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][crate::services::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][crate::services::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][crate::services::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][crate::services::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§

Source§

impl Scheme

Source

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

Convert self into static str.

Source

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§

Source§

impl Clone for Scheme

Source§

fn clone(&self) -> Scheme

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Scheme

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Scheme

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Scheme

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Scheme> for &'static str

Source§

fn from(v: Scheme) -> Self

Converts to this type from the input type.
Source§

impl From<Scheme> for String

Source§

fn from(v: Scheme) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Scheme

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Scheme

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Scheme

Source§

fn eq(&self, other: &Scheme) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Scheme

Source§

impl Eq for Scheme

Source§

impl StructuralPartialEq for Scheme

Auto Trait Implementations§

§

impl Freeze for Scheme

§

impl RefUnwindSafe for Scheme

§

impl Send for Scheme

§

impl Sync for Scheme

§

impl Unpin for Scheme

§

impl UnwindSafe for Scheme

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ServiceExt for T

Source§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
Source§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
Source§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
Source§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
Source§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeSend for T
where T: Send,