Module opendal::raw

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 more less stable than public API, please don’t rely on them whenever possible.

Modules

• adapters
  Providing adapters and its implementations.
• oio
  oio provides OpenDAL’s raw traits and types that opendal returns as output.

Structs

• AccessorInfo
  Metadata for accessor, users can use this metadata to get information of underlying backend.
• BytesContentRange
  BytesContentRange is the content range of bytes.
• BytesRange
  BytesRange(offset, size) carries a range of content.
• ErrorResponse
  ErrorResponse carries HTTP status code, headers and body.
• HttpClient
  HttpClient that used across opendal.
• IncomingAsyncBody
  IncomingAsyncBody carries the content returned by remote servers.
• PresignedRequest
  PresignedRequest is a presigned request return by presign.
• RpBatch
  Reply for batch operation.
• RpCreate
  Reply for create operation
• RpDelete
  Reply for delete operation
• RpList
  Reply for list operation.
• RpPresign
  Reply for presign operation.
• RpRead
  Reply for read operation.
• RpScan
  Reply for scan operation.
• RpStat
  Reply for stat operation.
• RpWrite
  Reply for write operation.

Enums

• AccessorCapability
  AccessorCapability describes accessor’s advanced capability.
• AccessorHint
  AccessorHint describes accessor’s hint.
• AsyncBody
  Body used in async HTTP requests.
• BatchedResults
  Batch results of batch operations.
• Body
  Body used in blocking HTTP requests.
• Operation
  Operation is the name for APIs in Accessor.

Constants

• VERSION
  VERSION is the compiled version of OpenDAL.

Traits

• Accessor
  Underlying trait of all backends for implementors.
• Layer
  Layer is used to intercept the operations on the underlying storage.
• LayeredAccessor
  LayeredAccessor is layered accessor that forward all not implemented method to inner.

Functions

• build_abs_path
  build_abs_path will build an absolute path with root.
• build_rel_path
  build_rel_path will build a relative path towards root.
• build_rooted_abs_path
  build_rooted_abs_path will build an absolute path with root.
• format_authorization_by_basic
  format authorization header by basic auth.
• format_authorization_by_bearer
  format authorization header by bearer token.
• format_content_md5
  format content md5 header by given input.
• get_basename
  Get basename from path.
• get_parent
  Get parent from path.
• new_json_deserialize_error
  Parse json deserialize error into opendal::Error.
• new_json_serialize_error
  Parse json serialize error into opendal::Error.
• new_request_build_error
  Create a new error happened during building request.
• new_request_sign_error
  Create a new error happened during signing request.
• new_xml_deserialize_error
  Parse xml deserialize error into opendal::Error.
• normalize_path
  Make sure all operation are constructed by normalized path:
• normalize_root
  Make sure root is normalized to style like /abc/def/.
• parse_content_disposition
  Parse Content-Disposition for header map
• parse_content_length
  Parse content length from header map.
• parse_content_md5
  Parse content md5 from header map.
• parse_content_range
  Parse content range from header map.
• parse_content_type
  Parse content type from header map.
• parse_error_response
  parse_error_response will parse response into ErrorResponse.
• parse_etag
  Parse etag from header map.
• parse_into_metadata
  parse_into_metadata will parse standards http headers into Metadata.
• parse_last_modified
  Parse last modified from header map.
• parse_location
  Parse redirect location from header map
• percent_encode_path
  percent_encode_path will do percent encoding for http encode path.
• validate_path
  Validate given path is match with given EntryMode.

Type Definitions

• FusedAccessor
  FusedAccessor is the type erased accessor with Box<dyn Reader>.