pub trait Access: Send + Sync + Debug + Unpin + 'static {
type Reader: Read;
type Writer: Write;
type Lister: List;
type Deleter: Delete;
type BlockingReader: BlockingRead;
type BlockingWriter: BlockingWrite;
type BlockingLister: BlockingList;
type BlockingDeleter: BlockingDelete;
Show 18 methods
// Required method
fn info(&self) -> Arc<AccessorInfo>;
// Provided methods
fn create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend { ... }
fn stat(
&self,
path: &str,
args: OpStat,
) -> impl Future<Output = Result<RpStat>> + MaybeSend { ... }
fn read(
&self,
path: &str,
args: OpRead,
) -> impl Future<Output = Result<(RpRead, Self::Reader)>> + MaybeSend { ... }
fn write(
&self,
path: &str,
args: OpWrite,
) -> impl Future<Output = Result<(RpWrite, Self::Writer)>> + MaybeSend { ... }
fn delete(
&self,
) -> impl Future<Output = Result<(RpDelete, Self::Deleter)>> + MaybeSend { ... }
fn list(
&self,
path: &str,
args: OpList,
) -> impl Future<Output = Result<(RpList, Self::Lister)>> + MaybeSend { ... }
fn copy(
&self,
from: &str,
to: &str,
args: OpCopy,
) -> impl Future<Output = Result<RpCopy>> + MaybeSend { ... }
fn rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> impl Future<Output = Result<RpRename>> + MaybeSend { ... }
fn presign(
&self,
path: &str,
args: OpPresign,
) -> impl Future<Output = Result<RpPresign>> + MaybeSend { ... }
fn blocking_create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> Result<RpCreateDir> { ... }
fn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat> { ... }
fn blocking_read(
&self,
path: &str,
args: OpRead,
) -> Result<(RpRead, Self::BlockingReader)> { ... }
fn blocking_write(
&self,
path: &str,
args: OpWrite,
) -> Result<(RpWrite, Self::BlockingWriter)> { ... }
fn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)> { ... }
fn blocking_list(
&self,
path: &str,
args: OpList,
) -> Result<(RpList, Self::BlockingLister)> { ... }
fn blocking_copy(
&self,
from: &str,
to: &str,
args: OpCopy,
) -> Result<RpCopy> { ... }
fn blocking_rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> Result<RpRename> { ... }
}
Expand description
Underlying trait of all backends for implementers.
The actual data access of storage service happens in Accessor layer.
Every storage supported by OpenDAL must implement Access
but not all
methods of Access
will be implemented according to how the storage service is.
For example, user can not modify the content from one HTTP file server directly.
So Http
implements and provides only read related actions.
Access
gives default implementation for all methods which will raise ErrorKind::Unsupported
error.
And what action this Access
supports will be pointed out in AccessorInfo
.
§Note
Visit internals
for more tutorials.
§Operations
- Path in args will all be normalized into the same style, services
should handle them based on services’ requirement.
- Path that ends with
/
means it’s Dir, otherwise, it’s File. - Root dir is
/
- Path will never be empty.
- Path that ends with
- Operations without capability requirement like
metadata
,create
are basic operations.- All services must implement them.
- Use
unimplemented!()
if not implemented or can’t implement.
- Operations with capability requirement like
presign
are optional operations.- Services can implement them based on services capabilities.
- The default implementation should return
ErrorKind::Unsupported
.
Required Associated Types§
sourcetype BlockingReader: BlockingRead
type BlockingReader: BlockingRead
BlockingReader is the associated reader returned blocking_read
operation.
sourcetype BlockingWriter: BlockingWrite
type BlockingWriter: BlockingWrite
BlockingWriter is the associated writer returned blocking_write
operation.
sourcetype BlockingLister: BlockingList
type BlockingLister: BlockingList
BlockingLister is the associated lister returned blocking_list
operation.
sourcetype BlockingDeleter: BlockingDelete
type BlockingDeleter: BlockingDelete
BlockingDeleter is the associated deleter returned blocking_delete
operation.
Required Methods§
sourcefn info(&self) -> Arc<AccessorInfo>
fn info(&self) -> Arc<AccessorInfo>
Invoke the info
operation to get metadata of accessor.
§Notes
This function is required to be implemented.
By returning AccessorInfo, underlying services can declare some useful information about itself.
- scheme: declare the scheme of backend.
- capabilities: declare the capabilities of current backend.
Provided Methods§
sourcefn create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend
fn create_dir( &self, path: &str, args: OpCreateDir, ) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend
Invoke the create
operation on the specified path
Require Capability::create_dir
§Behavior
- Input path MUST match with EntryMode, DON’T NEED to check mode.
- Create on existing dir SHOULD succeed.
sourcefn stat(
&self,
path: &str,
args: OpStat,
) -> impl Future<Output = Result<RpStat>> + MaybeSend
fn stat( &self, path: &str, args: OpStat, ) -> impl Future<Output = Result<RpStat>> + MaybeSend
Invoke the stat
operation on the specified path.
Require Capability::stat
§Behavior
stat
empty path means stat backend’s root path.stat
a path endswith “/” means stating a dir.mode
andcontent_length
must be set.
sourcefn read(
&self,
path: &str,
args: OpRead,
) -> impl Future<Output = Result<(RpRead, Self::Reader)>> + MaybeSend
fn read( &self, path: &str, args: OpRead, ) -> impl Future<Output = Result<(RpRead, Self::Reader)>> + MaybeSend
Invoke the read
operation on the specified path, returns a
Reader
if operate successful.
Require Capability::read
§Behavior
- Input path MUST be file path, DON’T NEED to check mode.
- The returning content length may be smaller than the range specified.
sourcefn write(
&self,
path: &str,
args: OpWrite,
) -> impl Future<Output = Result<(RpWrite, Self::Writer)>> + MaybeSend
fn write( &self, path: &str, args: OpWrite, ) -> impl Future<Output = Result<(RpWrite, Self::Writer)>> + MaybeSend
Invoke the write
operation on the specified path, returns a
written size if operate successful.
Require Capability::write
§Behavior
- Input path MUST be file path, DON’T NEED to check mode.
sourcefn delete(
&self,
) -> impl Future<Output = Result<(RpDelete, Self::Deleter)>> + MaybeSend
fn delete( &self, ) -> impl Future<Output = Result<(RpDelete, Self::Deleter)>> + MaybeSend
Invoke the delete
operation on the specified path.
Require Capability::delete
§Behavior
delete
is an idempotent operation, it’s safe to callDelete
on the same path multiple times.delete
SHOULD returnOk(())
if the path is deleted successfully or not exist.
sourcefn list(
&self,
path: &str,
args: OpList,
) -> impl Future<Output = Result<(RpList, Self::Lister)>> + MaybeSend
fn list( &self, path: &str, args: OpList, ) -> impl Future<Output = Result<(RpList, Self::Lister)>> + MaybeSend
Invoke the list
operation on the specified path.
Require Capability::list
§Behavior
- Input path MUST be dir path, DON’T NEED to check mode.
- List non-exist dir should return Empty.
sourcefn copy(
&self,
from: &str,
to: &str,
args: OpCopy,
) -> impl Future<Output = Result<RpCopy>> + MaybeSend
fn copy( &self, from: &str, to: &str, args: OpCopy, ) -> impl Future<Output = Result<RpCopy>> + MaybeSend
Invoke the copy
operation on the specified from
path and to
path.
Require Capability::copy
§Behaviour
from
andto
MUST be file path, DON’T NEED to check mode.- Copy on existing file SHOULD succeed.
- Copy on existing file SHOULD overwrite and truncate.
sourcefn rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> impl Future<Output = Result<RpRename>> + MaybeSend
fn rename( &self, from: &str, to: &str, args: OpRename, ) -> impl Future<Output = Result<RpRename>> + MaybeSend
Invoke the rename
operation on the specified from
path and to
path.
Require Capability::rename
sourcefn presign(
&self,
path: &str,
args: OpPresign,
) -> impl Future<Output = Result<RpPresign>> + MaybeSend
fn presign( &self, path: &str, args: OpPresign, ) -> impl Future<Output = Result<RpPresign>> + MaybeSend
Invoke the presign
operation on the specified path.
Require Capability::presign
§Behavior
- This API is optional, return
std::io::ErrorKind::Unsupported
if not supported.
sourcefn blocking_create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> Result<RpCreateDir>
fn blocking_create_dir( &self, path: &str, args: OpCreateDir, ) -> Result<RpCreateDir>
Invoke the blocking_create
operation on the specified path.
This operation is the blocking version of Accessor::create_dir
Require Capability::create_dir
and Capability::blocking
sourcefn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat>
fn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat>
Invoke the blocking_stat
operation on the specified path.
This operation is the blocking version of Accessor::stat
Require Capability::stat
and Capability::blocking
sourcefn blocking_read(
&self,
path: &str,
args: OpRead,
) -> Result<(RpRead, Self::BlockingReader)>
fn blocking_read( &self, path: &str, args: OpRead, ) -> Result<(RpRead, Self::BlockingReader)>
Invoke the blocking_read
operation on the specified path.
This operation is the blocking version of Accessor::read
Require Capability::read
and Capability::blocking
sourcefn blocking_write(
&self,
path: &str,
args: OpWrite,
) -> Result<(RpWrite, Self::BlockingWriter)>
fn blocking_write( &self, path: &str, args: OpWrite, ) -> Result<(RpWrite, Self::BlockingWriter)>
Invoke the blocking_write
operation on the specified path.
This operation is the blocking version of Accessor::write
Require Capability::write
and Capability::blocking
sourcefn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)>
fn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)>
Invoke the blocking_delete
operation on the specified path.
This operation is the blocking version of Accessor::delete
Require Capability::write
and Capability::blocking
sourcefn blocking_list(
&self,
path: &str,
args: OpList,
) -> Result<(RpList, Self::BlockingLister)>
fn blocking_list( &self, path: &str, args: OpList, ) -> Result<(RpList, Self::BlockingLister)>
Invoke the blocking_list
operation on the specified path.
This operation is the blocking version of Accessor::list
Require Capability::list
and Capability::blocking
§Behavior
- List non-exist dir should return Empty.
sourcefn blocking_copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy>
fn blocking_copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy>
Invoke the blocking_copy
operation on the specified from
path and to
path.
This operation is the blocking version of Accessor::copy
Require Capability::copy
and Capability::blocking
sourcefn blocking_rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> Result<RpRename>
fn blocking_rename( &self, from: &str, to: &str, args: OpRename, ) -> Result<RpRename>
Invoke the blocking_rename
operation on the specified from
path and to
path.
This operation is the blocking version of Accessor::rename
Require Capability::rename
and Capability::blocking
Object Safety§
Implementations on Foreign Types§
source§impl<T: Access + ?Sized> Access for Arc<T>
impl<T: Access + ?Sized> Access for Arc<T>
All functions in Accessor
only requires &self
, so it’s safe to implement
Accessor
for Arc<impl Access>
.