Expand description
oio provides OpenDAL’s raw traits and types that opendal returns as
output.
Those types should only be used internally and we don’t want users to depend on them.
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
Writer - BlockWriter will implement
oio::Writebased on block uploads. - Entry
- Entry is returned by
PageorBlockingPageduring list operations. - 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.
- Multipart
Part - The result of
MultipartWrite::write_part. - Multipart
Writer - MultipartWriter will implement
oio::Writebased on multipart uploads. - OneShot
Deleter - OneShotDelete is used to implement
oio::Deletebased on one shot. - OneShot
Writer - OneShotWrite is used to implement
oio::Writebased on one shot. - 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
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.
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
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. - Blocking
Delete - BlockingDelete is the trait to perform delete operations.
- Blocking
List - BlockingList is the blocking version of
List. - Blocking
OneShot Delete - BlockingOneShotDelete is used to implement
oio::BlockingDeletebased on one shot operation. - Blocking
Read - Read is the trait that OpenDAL returns to callers.
- Blocking
Write - BlockingWrite is the trait that OpenDAL returns to callers.
- Delete
- The Delete trait defines interfaces for performing deletion operations.
- Delete
Dyn - The dyn version of
Delete - List
- Page trait is used by
raw::Accessorto implementlistoperation. - 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
Write - PositionWrite is used to implement
oio::Writebased on position write. - Read
- Read is the internal trait used by OpenDAL to read data from storage.
- ReadDyn
- ReadDyn is the dyn version of
Readmake it possible to use asBox<dyn ReadDyn>. - Write
- Write is the trait that OpenDAL returns to callers.
Type Aliases§
- Blocking
Deleter - BlockingDeleter is a type erased
BlockingDelete - Blocking
Lister - BlockingLister is a boxed
BlockingList - Blocking
Reader - BlockingReader is a arc dyn
BlockingRead. - Blocking
Writer - BlockingWriter is a type erased
BlockingWrite - Deleter
- Deleter is a type erased
Delete - Lister
- The boxed version of
List - Reader
- Reader is a type erased
Read. - Writer
- Writer is a type erased
Write