Crate opendal 

Facade crate that re-exports all public APIs from opendal-core.

Modules

blocking

blocking module provides blocking APIs for OpenDAL.

executors

executors module provides implementations for the Execute trait for widely used runtimes.

layers

Layer is the mechanism to intercept operations.

operator_futures

Futures provides the futures generated by Operator

options

Options module provides options definitions for operations.

raw

Raw modules provide raw APIs that used by underlying services

services

Services will provide builders to build underlying backends.

Structs

Buffer

Buffer is a wrapper of contiguous Bytes and non-contiguous [Bytes].

BufferSink

BufferSink is the adapter of [futures::Sink] generated by Writer::into_sink

BufferStream

BufferStream is a stream of buffers, created by Reader::into_stream

Capability

Capability defines the supported operations and their constraints for a storage Operator.

DeleteInput

DeleteInput is the input for delete operations.

Deleter

Deleter is designed to continuously remove content from storage.

Entry

Entry returned by Lister or [BlockingLister] to represent a path and it’s relative metadata.

Error

Error is the error struct returned by all opendal functions.

Executor

Executor that runs futures in background.

FuturesAsyncReader

FuturesAsyncReader is the adapter of [AsyncRead], [AsyncBufRead] and [AsyncSeek] generated by Reader::into_futures_async_read.

FuturesAsyncWriter

FuturesIoAsyncWriter is the adapter of [AsyncWrite] for Writer.

FuturesBytesSink

FuturesBytesSink is the adapter of [futures::Sink] generated by Writer::into_bytes_sink.

FuturesBytesStream

FuturesBytesStream is the adapter of [Stream] generated by Reader::into_bytes_stream.

FuturesDeleteSink

FuturesDeleteSink is a sink that generated by Deleter

Lister

Lister is designed to list entries at given path in an asynchronous manner.

Metadata

Metadata contains all the information related to a specific path.

Operator

The Operator serves as the entry point for all public asynchronous APIs.

OperatorBuilder

OperatorBuilder is a typed builder to build an Operator.

OperatorInfo

Metadata for operator, users can use this metadata to get information of operator.

OperatorRegistry

Global registry that maps schemes to OperatorFactory functions.

OperatorUri

Parsed representation of an operator URI with normalized components.

Reader

Reader is designed to read data from given path in an asynchronous manner.

Writer

Writer is designed to write data into given path in an asynchronous manner.

Enums

EntryMode

EntryMode represents the mode.

ErrorKind

ErrorKind is all kinds of Error of opendal.

Scheme

Services that OpenDAL supports

Statics

DEFAULT_OPERATOR_REGISTRY

Default registry initialized with builtin services.

Traits

Builder

Builder is used to set up underlying services.

Configurator

Configurator is used to configure the underlying service.

Execute

Execute trait is used to execute task in background.

IntoDeleteInput

IntoDeleteInput is a helper trait that makes it easier for users to play with Deleter.

IntoOperatorUri

Conversion trait that builds OperatorUri from various inputs.

Type Aliases

OperatorFactory

Factory signature used to construct Operator from a URI and extra options.

Result

Result that is a wrapper of Result<T, opendal::Error>