1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::fmt::Debug;
use std::future::ready;
use std::ops::DerefMut;
use futures::Future;
use crate::raw::*;
use crate::Capability;
use crate::Scheme;
use crate::*;
/// Scan is the async iterator returned by `Adapter::scan`.
pub trait Scan: Send + Sync + Unpin {
/// Fetch the next key in the current key prefix
///
/// `Ok(None)` means no further key will be returned
fn next(&mut self) -> impl Future<Output = Result<Option<String>>> + MaybeSend;
}
/// A noop implementation of Scan
impl Scan for () {
async fn next(&mut self) -> Result<Option<String>> {
Ok(None)
}
}
/// A Scan implementation for all trivial non-async iterators
pub struct ScanStdIter<I>(I);
#[cfg(any(
feature = "services-cloudflare-kv",
feature = "services-etcd",
feature = "services-nebula-graph",
feature = "services-rocksdb",
feature = "services-sled"
))]
impl<I> ScanStdIter<I>
where
I: Iterator<Item = Result<String>> + Unpin + Send + Sync,
{
/// Create a new ScanStdIter from an Iterator
pub(crate) fn new(inner: I) -> Self {
Self(inner)
}
}
impl<I> Scan for ScanStdIter<I>
where
I: Iterator<Item = Result<String>> + Unpin + Send + Sync,
{
async fn next(&mut self) -> Result<Option<String>> {
self.0.next().transpose()
}
}
/// A type-erased wrapper of Scan
pub type Scanner = Box<dyn ScanDyn>;
pub trait ScanDyn: Unpin + Send + Sync {
fn next_dyn(&mut self) -> BoxedFuture<Result<Option<String>>>;
}
impl<T: Scan + ?Sized> ScanDyn for T {
fn next_dyn(&mut self) -> BoxedFuture<Result<Option<String>>> {
Box::pin(self.next())
}
}
impl<T: ScanDyn + ?Sized> Scan for Box<T> {
async fn next(&mut self) -> Result<Option<String>> {
self.deref_mut().next_dyn().await
}
}
/// KvAdapter is the adapter to underlying kv services.
///
/// By implement this trait, any kv service can work as an OpenDAL Service.
pub trait Adapter: Send + Sync + Debug + Unpin + 'static {
/// TODO: use default associate type `= ()` after stablized
type Scanner: Scan;
/// Return the info of this key value accessor.
fn info(&self) -> Info;
/// Get a key from service.
///
/// - return `Ok(None)` if this key is not exist.
fn get(&self, path: &str) -> impl Future<Output = Result<Option<Buffer>>> + MaybeSend;
/// The blocking version of get.
fn blocking_get(&self, path: &str) -> Result<Option<Buffer>> {
let _ = path;
Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::blocking_get"))
}
/// Set a key into service.
fn set(&self, path: &str, value: Buffer) -> impl Future<Output = Result<()>> + MaybeSend;
/// The blocking version of set.
fn blocking_set(&self, path: &str, value: Buffer) -> Result<()> {
let _ = (path, value);
Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::blocking_set"))
}
/// Delete a key from service.
///
/// - return `Ok(())` even if this key is not exist.
fn delete(&self, path: &str) -> impl Future<Output = Result<()>> + MaybeSend;
/// Delete a key from service in blocking way.
///
/// - return `Ok(())` even if this key is not exist.
fn blocking_delete(&self, path: &str) -> Result<()> {
let _ = path;
Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::blocking_delete"))
}
/// Scan a key prefix to get all keys that start with this key.
fn scan(&self, path: &str) -> impl Future<Output = Result<Self::Scanner>> + MaybeSend {
let _ = path;
ready(Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::scan")))
}
/// Scan a key prefix to get all keys that start with this key
/// in blocking way.
fn blocking_scan(&self, path: &str) -> Result<Vec<String>> {
let _ = path;
Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::blocking_scan"))
}
/// Append a key into service
fn append(&self, path: &str, value: &[u8]) -> impl Future<Output = Result<()>> + MaybeSend {
let _ = path;
let _ = value;
ready(Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::append")))
}
/// Append a key into service
/// in blocking way.
fn blocking_append(&self, path: &str, value: &[u8]) -> Result<()> {
let _ = path;
let _ = value;
Err(Error::new(
ErrorKind::Unsupported,
"kv adapter doesn't support this operation",
)
.with_operation("kv::Adapter::blocking_append"))
}
}
/// Info for this key value accessor.
pub struct Info {
scheme: Scheme,
name: String,
capabilities: Capability,
}
impl Info {
/// Create a new KeyValueAccessorInfo.
pub fn new(scheme: Scheme, name: &str, capabilities: Capability) -> Self {
Self {
scheme,
name: name.to_string(),
capabilities,
}
}
/// Get the scheme.
pub fn scheme(&self) -> Scheme {
self.scheme
}
/// Get the name.
pub fn name(&self) -> &str {
&self.name
}
/// Get the capabilities.
pub fn capabilities(&self) -> Capability {
self.capabilities
}
}