Struct opendal::raw::adapters::kv::Backend

pub struct Backend<S: Adapter> { /* private fields */ }

Backend of kv service. If the storage service is one k-v-like service, it should implement this kv Backend by right.

Backend implements one general logic on how to read, write, scan the data from one kv store efficiently. And the Adapter held by Backend will handle how to communicate with one k-v-like service really and provides a series of basic operation for this service.

OpenDAL developer can implement one new k-v store backend easily with help of this Backend.

Implementations

impl<S> Backend<S>

where S: Adapter,

pub fn new(kv: S) -> Self

Create a new kv backend.

pub fn with_root(self, root: &str) -> Self

Configure root within this backend.

Trait Implementations

impl<S: Adapter> Access for Backend<S>

type Reader = Buffer

Reader is the associated reader returned in read operation.

type Writer = KvWriter<S>

Writer is the associated writer returned in write operation.

type Lister = HierarchyLister<KvLister<<S as Adapter>::Scanner>>

Lister is the associated lister returned in list operation.

type Deleter = OneShotDeleter<KvDeleter<S>>

Deleter is the associated deleter returned in delete operation.

type BlockingReader = Buffer

BlockingReader is the associated reader returned blocking_read operation.

type BlockingWriter = KvWriter<S>

BlockingWriter is the associated writer returned blocking_write operation.

type BlockingLister = HierarchyLister<BlockingKvLister>

BlockingLister is the associated lister returned blocking_list operation.

type BlockingDeleter = OneShotDeleter<KvDeleter<S>>

BlockingDeleter is the associated deleter returned blocking_delete operation.

fn info(&self) -> Arc<AccessorInfo>

Invoke the info operation to get metadata of accessor.

async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat>

Invoke the stat operation on the specified path.

async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)>

Invoke the read operation on the specified path, returns a Reader if operate successful.

async fn write(&self, path: &str, _: OpWrite) -> Result<(RpWrite, Self::Writer)>

Invoke the write operation on the specified path, returns a written size if operate successful.

async fn delete(&self) -> Result<(RpDelete, Self::Deleter)>

Invoke the delete operation on the specified path.

async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)>

Invoke the list operation on the specified path.

fn blocking_stat(&self, path: &str, _: OpStat) -> Result<RpStat>

Invoke the blocking_stat operation on the specified path.

fn blocking_read( &self, path: &str, args: OpRead, ) -> Result<(RpRead, Self::BlockingReader)>

Invoke the blocking_read operation on the specified path.

fn blocking_write( &self, path: &str, _: OpWrite, ) -> Result<(RpWrite, Self::BlockingWriter)>

Invoke the blocking_write operation on the specified path.

fn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)>

Invoke the blocking_delete operation on the specified path.

fn blocking_list( &self, path: &str, args: OpList, ) -> Result<(RpList, Self::BlockingLister)>

Invoke the blocking_list operation on the specified path.

fn create_dir( &self, path: &str, args: OpCreateDir, ) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend

Invoke the create operation on the specified path

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.

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.

fn presign( &self, path: &str, args: OpPresign, ) -> impl Future<Output = Result<RpPresign>> + MaybeSend

Invoke the presign operation on the specified path.

fn blocking_create_dir( &self, path: &str, args: OpCreateDir, ) -> Result<RpCreateDir>

Invoke the blocking_create operation on the specified path.

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.

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.

impl<S: Clone + Adapter> Clone for Backend<S>

fn clone(&self) -> Backend<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + Adapter> Debug for Backend<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.