Modules§
- oio
oioprovides OpenDAL’s raw traits and types that opendal returns as output.
Structs§
- Append
Writer - AppendWriter will implements
oio::Writebased on append object. - Batch
Delete Result - BatchDeleteResult is the result of batch delete operation.
- Batch
Deleter - BatchDeleter is used to implement
oio::Deletebased on batch delete. - Block
Copier - BlockCopier implements
oio::Copybased on block copy. - Block
Writer - BlockWriter will implement
oio::Writebased on block uploads. - Buffer
- Buffer is a wrapper of contiguous
Bytesand non-contiguous[Bytes]. - Entry
- Entry is returned by
PageorBlockingPageduring list operations. - Error
- Error is the error struct returned by all opendal functions.
- Flat
Lister - FlatLister will walk dir in bottom up way:
- FlexBuf
- FlexBuf is a buffer that support frozen bytes and reuse existing allocated memory.
- Hierarchy
Lister - ToHierarchyLister will convert a flat list to hierarchy by filter not needed entries.
- Metadata
- Metadata contains all the information related to a specific path.
- Mock
Deleter - Mock
Layer - Mock
Layer Builder - Builder for
MockLayer. - Mock
Lister - Mock
Reader - Mock
Service 🔒 - Mock
Writer - Multipart
Copier - MultipartCopier implements
oio::Copybased on multipart copy. - Multipart
Part - The result of
MultipartWrite::write_part. - Multipart
Writer - MultipartWriter will implement
oio::Writebased on multipart uploads. - OneShot
Copier - OneShotCopier drives a single asynchronous copy step.
- OneShot
Deleter - OneShotDelete is used to implement
oio::Deletebased on one shot. - OneShot
Writer - OneShotWrite is used to implement
oio::Writebased on one shot. - OpCopy
- Arguments for
copyoperation. - OpDelete
- Arguments for
deleteoperation. - OpList
- Arguments for
listoperation. - OpRead
- Arguments for
readoperation. - OpWrite
- Arguments for
writeoperation. - Operation
Context - Composed resources passed from operator to services and layers.
- Page
Context - PageContext is the context passing between
PageList. - Page
Lister - PageLister implements
oio::Listbased onPageList. - Pooled
Buf - PooledBuf is a buffer pool that designed for reusing already allocated bufs.
- Position
Reader - PositionReader implements
oio::Readbased onPositionRead. - Position
Writer - PositionWriter will implement
oio::Writebased on position write. - Prefix
Lister - PrefixLister is used to filter entries by prefix.
- Queue
Buf - QueueBuf is a queue of
Buffer. - RpRead
- Reply for
readoperation. - Stream
Reader - StreamReader implements
oio::Readbased onStreamRead.
Enums§
- Bytes
Range - BytesRange carries a range of content.
- Error
Kind - OpenDAL error categories.
- Mock
Layer Builder Error - Error type for MockLayerBuilder
Traits§
- Append
Write - AppendWrite is used to implement
oio::Writebased on append object. By implementing AppendWrite, services don’t need to care about the details of buffering and uploading parts. - Batch
Delete - BatchDelete is used to implement
oio::Deletebased on batch delete operation. - Block
Copy - BlockCopy is used to implement
oio::Copybased on block copy. - Block
Write - BlockWrite is used to implement
oio::Writebased on block uploads. By implementing BlockWrite, services don’t need to care about the details of uploading blocks. - Copy
- Copy is the trait that OpenDAL returns for stateful copy operations.
- CopyDyn
- CopyDyn is the dyn version of
Copy. - Delete
- The Delete trait defines interfaces for performing deletion operations.
- Delete
Dyn - The dyn version of
Delete. - Into
Multipart Copy Context - Build executor and capability inputs for
MultipartCopier. - Layer
- Layer intercepts an operator’s composed runtime resources.
- List
- List is returned by
Serviceto stream entries for alistoperation. - ListDyn
- ListDyn is the dyn version of
List. - Multipart
Copy - MultipartCopy is used to implement
oio::Copybased on multipart copy. - Multipart
Write - MultipartWrite is used to implement
oio::Writebased on multipart uploads. By implementing MultipartWrite, services don’t need to care about the details of uploading parts. - OneShot
Delete - OneShotDelete is used to implement
oio::Deletebased on one shot operation. - OneShot
Write - OneShotWrite is used to implement
oio::Writebased on one shot operation. By implementing OneShotWrite, services don’t need to care about the details. - Page
List - PageList is used to implement
oio::Listbased on API supporting pagination. By implementing PageList, services don’t need to care about the details of page list. - Position
Read - PositionRead is used to implement
oio::Readbased on positioned reads. - Position
Write - PositionWrite is used to implement
oio::Writebased on position write. - Read
- Read is the internal trait used by OpenDAL to read ranges from storage.
- ReadDyn
- ReadDyn is the dyn-compatible adapter for
Read. - Read
Stream - ReadStream is the internal trait used by OpenDAL to stream data from storage.
- Read
Stream Dyn - ReadStreamDyn is the dyn-compatible adapter for
ReadStream. - Service
- Foundational trait for storage services.
- Stream
Read - StreamRead is used to implement
oio::Readbased on native range streams. - Write
- Write is the async sink used by services and layers.
- Write
Dyn - WriteDyn is the object-safe version of
Writeused byWriter.
Type Aliases§
- Copier
- Copier is the type-erased
Copy. - Copy
Interceptor - Deleter
- Deleter is a type erased
Delete. - Lister
- Lister is the type-erased
List. - Mock
Deleter Factory - Mock
Lister Factory - Mock
Reader Factory - Mock
Writer Factory - Reader
- Reader is a type erased
Read. - Result
- A specialized
std::result::Resultwhose default error type isError. - Servicer
- Type-erased service handle used by layer composition and operators.
- Writer
- Writer is a type-erased
Write.