opendal Namespace Reference

Namespaces
namespace	async
namespace	ffi

Classes
class	Capability
struct	CopyOptions
	Options for copy operations. More...
struct	DeleteOptions
	Options for delete operations. More...
struct	Entry
	The entry of a file or directory. More...
class	FfiLayerBuilderMutator
	Applies layers through the cxx bridge. More...
class	LayerBuilderMutator
	Abstraction for applying layers during operator construction. More...
class	Lister
	Lister is designed to list the entries of a directory. More...
struct	ListOptions
	Options for list and lister operations. More...
struct	Metadata
	The metadata of a file or directory. More...
class	Operator
	Operator is the entry for all public APIs. More...
class	OperatorOption
	Configures operator layers applied during construction. More...
class	Reader
	Reader is designed to read data from the operator. More...
struct	ReaderOptions
	Options for creating readers. More...
class	ReaderStream
	ReaderStream is a stream wrapper of Reader which provides iostream interface. It wraps the Reader to provide standard stream operations. More...
struct	ReadOptions
	Options for read operations. More...
struct	ReadRange
	Byte range used by read operations. More...
struct	RenameOptions
	Options for rename operations. More...
struct	RetryConfig
	Configuration for the retry layer. More...
struct	StatOptions
	Options for stat operations. More...
struct	WriteOptions
	Options for write and writer operations. More...
class	Writer
	Writer is designed to write a sequence of byte buffers to an object. More...

Enumerations
enum class	EntryMode : int { FILE = 1 , DIR = 2 , UNKNOWN = 0 }
	The mode of the entry. More...

Functions
std::unique_ptr< OperatorOption >	WithTimeout (std::chrono::nanoseconds timeout, std::chrono::nanoseconds io_timeout)
	Adds a timeout layer to the operator.
std::unique_ptr< OperatorOption >	WithRetry (RetryConfig config={})
	Adds a retry layer to the operator.
std::vector< std::unique_ptr< OperatorOption > >	DefaultBehaviorLayerOptions ()
	Default layer options used by behavior tests.

Enumeration Type Documentation

EntryMode

enum class opendal::EntryMode : int

strong

The mode of the entry.

Enumerator
FILE
DIR
UNKNOWN

Function Documentation

DefaultBehaviorLayerOptions()

std::vector< std::unique_ptr< OperatorOption > > opendal::DefaultBehaviorLayerOptions

(

)

Default layer options used by behavior tests.

WithRetry()

std::unique_ptr< OperatorOption > opendal::WithRetry

(

RetryConfig

config = {}

)

Adds a retry layer to the operator.

Layers are applied in the order passed to Operator. When combining retry and timeout, pass WithTimeout before WithRetry so each retry attempt has its own timeout.

WithTimeout()

std::unique_ptr< OperatorOption > opendal::WithTimeout	(	std::chrono::nanoseconds	timeout,
		std::chrono::nanoseconds	io_timeout
	)

Adds a timeout layer to the operator.

timeout controls non-IO operations, while io_timeout controls read, write, list, and streaming IO operations.