pub struct Backend<S: Adapter> { /* private fields */ }
Expand description
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§
Trait Implementations§
source§impl<S: Adapter> Access for Backend<S>
impl<S: Adapter> Access for Backend<S>
§type Lister = HierarchyLister<KvLister<<S as Adapter>::Scanner>>
type Lister = HierarchyLister<KvLister<<S as Adapter>::Scanner>>
Lister is the associated lister returned in
list
operation.§type Deleter = OneShotDeleter<KvDeleter<S>>
type Deleter = OneShotDeleter<KvDeleter<S>>
Deleter is the associated deleter returned in
delete
operation.§type BlockingReader = Buffer
type BlockingReader = Buffer
BlockingReader is the associated reader returned
blocking_read
operation.§type BlockingWriter = KvWriter<S>
type BlockingWriter = KvWriter<S>
BlockingWriter is the associated writer returned
blocking_write
operation.§type BlockingLister = HierarchyLister<BlockingKvLister>
type BlockingLister = HierarchyLister<BlockingKvLister>
BlockingLister is the associated lister returned
blocking_list
operation.§type BlockingDeleter = OneShotDeleter<KvDeleter<S>>
type BlockingDeleter = OneShotDeleter<KvDeleter<S>>
BlockingDeleter is the associated deleter returned
blocking_delete
operation.source§fn info(&self) -> Arc<AccessorInfo>
fn info(&self) -> Arc<AccessorInfo>
Invoke the
info
operation to get metadata of accessor. Read moresource§async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat>
async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat>
Invoke the
stat
operation on the specified path. Read moresource§async fn write(&self, path: &str, _: OpWrite) -> Result<(RpWrite, Self::Writer)>
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. Read moresource§async fn delete(&self) -> Result<(RpDelete, Self::Deleter)>
async fn delete(&self) -> Result<(RpDelete, Self::Deleter)>
Invoke the
delete
operation on the specified path. Read moresource§async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)>
async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)>
Invoke the
list
operation on the specified path. Read moresource§fn blocking_stat(&self, path: &str, _: OpStat) -> Result<RpStat>
fn blocking_stat(&self, path: &str, _: OpStat) -> Result<RpStat>
Invoke the
blocking_stat
operation on the specified path. Read moresource§fn 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. Read moresource§fn blocking_write(
&self,
path: &str,
_: OpWrite,
) -> Result<(RpWrite, Self::BlockingWriter)>
fn blocking_write( &self, path: &str, _: OpWrite, ) -> Result<(RpWrite, Self::BlockingWriter)>
Invoke the
blocking_write
operation on the specified path. Read moresource§fn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)>
fn blocking_delete(&self) -> Result<(RpDelete, Self::BlockingDeleter)>
Invoke the
blocking_delete
operation on the specified path. Read moresource§fn 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. Read moresource§fn 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 Read moresource§fn 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
source§fn 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
source§fn 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. Read moresource§fn 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. Read moreAuto Trait Implementations§
impl<S> Freeze for Backend<S>
impl<S> RefUnwindSafe for Backend<S>where
S: RefUnwindSafe,
impl<S> Send for Backend<S>
impl<S> Sync for Backend<S>
impl<S> Unpin for Backend<S>
impl<S> UnwindSafe for Backend<S>where
S: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.