Expand description
Raw modules provide raw APIs that used by underlying services
§Notes
- Only developers who want to develop new services or layers need to access raw APIs.
- Raw APIs should only be accessed via
opendal::raw::Xxxx
, any public API should never expose raw API directly. - Raw APIs are far less stable than public API, please don’t rely on them whenever possible.
Modules§
- Providing adapters and its implementations.
oio
provides OpenDAL’s raw traits and types that opendal returns as output.- tests
tests
Utilities for opendal testing.
Structs§
- Metadata for accessor, users can use this metadata to get information of underlying backend.
- AtomicContentLength is a wrapper of AtomicU64 that used to store content length.
- BytesContentRange is the content range of bytes.
- BytesRange(offset, size) carries a range of content.
- ConcurrentFutures is a stream that can hold a stream of concurrent futures.
- ConcurrentTasks is used to execute tasks concurrently.
- ConfigDeserializer is used to deserialize given configs from
HashMap<String, String>
. - FormDataPart is a builder for multipart/form-data part.
- HttpBody is the streaming body that opendal’s HttpClient returned.
- HttpClient that used across opendal.
- MixedPart is a builder for multipart/mixed part.
- Multipart is a builder for multipart/form-data.
- Args for
batch
operation. - Args for
copy
operation. - Args for
create
operation. - Args for
delete
operation. - Args for
list
operation. - Args for
presign
operation. - Args for
read
operation. - Args for reader operation.
- Args for
rename
operation. - Args for
stat
operation. - Args for
write
operation. - Args for
writer
operation. - PathCacher
internal-path-cache
PathCacher is a cache for path query. - PresignedRequest is a presigned request return by
presign
. - Reply for
batch
operation. - Reply for
copy
operation. - Reply for
create_dir
operation - Reply for
delete
operation - Reply for
list
operation. - Reply for
presign
operation. - Reply for
read
operation. - Reply for
rename
operation. - Reply for
stat
operation. - Reply for
write
operation.
Enums§
- Batch operation used for batch.
- Batch results of
batch
operations. - FourWays is used to implement traits that based on four ways.
- Operation is the name for APIs in
Accessor
. - Presign operation used for presign.
- ThreeWays is used to implement traits that based on three ways.
- TwoWays is used to implement traits that based on two ways.
Constants§
- VERSION is the compiled version of OpenDAL.
Traits§
- Underlying trait of all backends for implementers.
- HttpFetch is the trait to fetch a request in async way. User should implement this trait to provide their own http client.
- Layer is used to intercept the operations on the underlying storage.
- LayeredAccess is layered accessor that forward all not implemented method to inner.
- MaybeSend is a marker to determine whether a type is
Send
or not. We use this trait to wrap theSend
requirement for wasm32 target. - Part is a trait for multipart part.
- PathQuery
internal-path-cache
The trait required for path cacher.
Functions§
- build_abs_path will build an absolute path with root.
- Build header value from given string.
- build_rel_path will build a relative path towards root.
- build_rooted_abs_path will build an absolute path with root.
- format authorization header by basic auth.
- format authorization header by bearer token.
- format content md5 header by given input.
- Get basename from path.
- Get parent from path.
- Parse json deserialize error into opendal::Error.
- Parse json serialize error into opendal::Error.
- Create a new error happened during building request.
- Create a new error happened during signing request.
- Create a new error happened during signing request.
- Parse std io error into opendal::Error.
- new_task_join_error
internal-tokio-rt
Parse tokio error into opendal::Error. - Parse xml deserialize error into opendal::Error.
- Make sure all operation are constructed by normalized path:
- Make sure root is normalized to style like
/abc/def/
. - Parse Content-Disposition for header map
- Parse content encoding from header map.
- Parse content length from header map.
- Parse content md5 from header map.
- Parse content range from header map.
- Parse content type from header map.
- parse datetime from given timestamp
- parse datetime from given timestamp_millis
- Parse dateimt from rfc2822.
- Parse dateimt from rfc3339.
- Parse etag from header map.
- Parse header value to string according to name.
- parse_into_metadata will parse standards http headers into Metadata.
- Parse last modified from header map.
- Parse redirect location from header map
- Parse prefixed headers and return a map with the prefix of each header removed.
- percent_decode_path will do percent decoding for http decode path.
- percent_encode_path will do percent encoding for http encode path.
- Validate given path is match with given EntryMode.
- Add response context to error.
Type Aliases§
- Accessor is the type erased accessor with
Arc<dyn Accessor>
. - BoxedFuture is the type alias of [
futures::future::BoxFuture
]. - BoxedStaticFuture is the type alias of [
futures::future::BoxFuture
].