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 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
// Copyright 2022 Datafuse Labs.
//
// Licensed 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::env;
use std::io::ErrorKind;
use std::io::Result;
use std::sync::Arc;
use futures::StreamExt;
use futures::TryStreamExt;
use log::debug;
use crate::io_util::BottomUpWalker;
use crate::io_util::TopDownWalker;
use crate::services;
use crate::Accessor;
use crate::AccessorMetadata;
use crate::DirStreamer;
use crate::Layer;
use crate::Object;
use crate::ObjectMode;
use crate::Scheme;
/// User-facing APIs for object and object streams.
#[derive(Clone, Debug)]
pub struct Operator {
accessor: Arc<dyn Accessor>,
}
impl<A> From<A> for Operator
where
A: Accessor + 'static,
{
fn from(accessor: A) -> Self {
Operator::new(accessor)
}
}
impl Operator {
/// Create a new operator.
///
/// # Examples
///
/// Read more backend init examples in [examples](https://github.com/datafuselabs/opendal/tree/main/examples).
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::Accessor;
/// # use opendal::Object;
/// # use opendal::Operator;
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// // Create fs backend builder.
/// let mut builder = fs::Builder::default();
/// // Set the root for fs, all operations will happen under this root.
/// //
/// // NOTE: the root must be absolute path.
/// builder.root("/tmp");
///
/// // `Accessor` provides the low level APIs, we will use `Operator` normally.
/// let op: Operator = Operator::new(builder.build()?);
///
/// // Create an object handle to start operation on object.
/// let _: Object = op.object("test_file");
///
/// Ok(())
/// }
/// ```
pub fn new(accessor: impl Accessor + 'static) -> Self {
Self {
accessor: Arc::new(accessor),
}
}
/// Create a new operator from iter.
///
/// Please refer different backends for detailed config options.
///
/// # Behavior
///
/// - All input key must be `lower_case`
/// - Boolean values will be checked by its existences and non-empty value.
/// `on`, `yes`, `true`, `off`, `no`, `false` will all be treated as `true`
/// To disable a flag, please set value to empty.
///
/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::Accessor;
/// # use opendal::Object;
/// # use opendal::Operator;
/// # use opendal::Scheme;
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let op: Operator = Operator::from_iter(
/// Scheme::Fs,
/// [("root".to_string(), "/tmp".to_string())].into_iter(),
/// )?;
///
/// // Create an object handle to start operation on object.
/// let _: Object = op.object("test_file");
///
/// Ok(())
/// }
/// ```
pub fn from_iter(scheme: Scheme, it: impl Iterator<Item = (String, String)>) -> Result<Self> {
let op = match scheme {
Scheme::Azblob => services::azblob::Backend::from_iter(it)?.into(),
Scheme::Fs => services::fs::Backend::from_iter(it)?.into(),
#[cfg(feature = "services-hdfs")]
Scheme::Hdfs => services::hdfs::Backend::from_iter(it)?.into(),
#[cfg(feature = "services-http")]
Scheme::Http => services::http::Backend::from_iter(it)?.into(),
Scheme::Memory => services::memory::Builder::default().build()?.into(),
Scheme::Gcs => services::gcs::Backend::from_iter(it)?.into(),
Scheme::S3 => services::s3::Backend::from_iter(it)?.into(),
};
Ok(op)
}
/// Create a new operator from env.
///
/// # Behavior
///
/// - Environment keys are case-insensitive, they will be converted to lower case internally.
/// - Environment values are case-sensitive, no sanity will be executed on them.
/// - Boolean values will be checked by its existences and non-empty value.
/// `on`, `yes`, `true`, `off`, `no`, `false` will all be treated as `true`
/// To disable a flag, please set value to empty.
///
/// # Examples
///
/// Setting environment:
///
/// ```shell
/// export OPENDAL_FS_ROOT=/tmp
/// ```
///
/// Please refer different backends for detailed config options.
///
/// ```
/// # use anyhow::Result;
/// # use opendal::Accessor;
/// # use opendal::Object;
/// # use opendal::Operator;
/// # use opendal::Scheme;
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// // `Accessor` provides the low level APIs, we will use `Operator` normally.
/// let op: Operator = Operator::from_env(Scheme::Fs)?;
///
/// // Create an object handle to start operation on object.
/// let _: Object = op.object("test_file");
///
/// Ok(())
/// }
/// ```
pub fn from_env(scheme: Scheme) -> Result<Self> {
let prefix = format!("opendal_{scheme}_");
let envs = env::vars().filter_map(|(k, v)| {
k.to_lowercase()
.strip_prefix(&prefix)
.map(|k| (k.to_string(), v))
});
Self::from_iter(scheme, envs)
}
/// Create a new layer.
///
/// # Examples
///
/// This examples needs feature `retry` enabled.
///
/// ```no_build
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::services::fs::Builder;
/// use opendal::Operator;
/// use opendal::Layer;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let accessor = fs::Backend::build().finish().await?;
/// let op = Operator::new(accessor).layer(new_layer);
/// // All operations will go through the new_layer
/// let _ = op.object("test_file").read();
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn layer(self, layer: impl Layer) -> Self {
Operator {
accessor: layer.layer(self.accessor),
}
}
/// Configure backoff for operators
///
/// This function only provided if feature `retry` is enabled.
///
/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::services::fs::Builder;
/// use backon::ExponentialBackoff;
/// use opendal::Operator;
/// use opendal::Scheme;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let op = Operator::from_env(Scheme::Fs)?.with_backoff(ExponentialBackoff::default());
/// // All operations will be retried if the error is retryable
/// let _ = op.object("test_file").read();
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "layers-retry")]
#[must_use]
#[deprecated = "Use `Operator::layer` and `RetryLayer` directly"]
pub fn with_backoff(
self,
backoff: impl backon::Backoff + Send + Sync + std::fmt::Debug + 'static,
) -> Self {
self.layer(crate::layers::RetryLayer::new(backoff))
}
fn inner(&self) -> Arc<dyn Accessor> {
self.accessor.clone()
}
/// Get metadata of underlying accessor.
///
/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::services::fs::Builder;
/// use opendal::Operator;
/// use opendal::Scheme;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let op = Operator::from_env(Scheme::Fs)?;
/// let meta = op.metadata();
/// # Ok(())
/// # }
/// ```
pub fn metadata(&self) -> AccessorMetadata {
self.accessor.metadata()
}
/// Create a new batch operator handle to take batch operations
/// like `walk` and `remove`.
pub fn batch(&self) -> BatchOperator {
BatchOperator::new(self.clone())
}
/// Create a new [`Object`][crate::Object] handle to take operations.
pub fn object(&self, path: &str) -> Object {
Object::new(self.inner(), path)
}
/// Check if this operator can work correctly.
///
/// We will send a `list` request to path and return any errors we met.
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// # use opendal::services::fs;
/// # use opendal::services::fs::Builder;
/// use opendal::Operator;
/// use opendal::Scheme;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let op = Operator::from_env(Scheme::Fs)?;
/// op.check().await?;
/// # Ok(())
/// # }
/// ```
pub async fn check(&self) -> Result<()> {
let mut ds = self.object("/").list().await?;
match ds.next().await {
Some(Err(e)) if e.kind() != ErrorKind::NotFound => Err(e),
_ => Ok(()),
}
}
}
/// BatchOperator is used to take batch operations like walk_dir and remove_all, should
/// be constructed by [`Operator::batch()`].
///
/// # TODO
///
/// We will support batch operators between two different operators like copy and move.
#[derive(Clone, Debug)]
pub struct BatchOperator {
src: Operator,
}
impl BatchOperator {
pub(crate) fn new(op: Operator) -> Self {
BatchOperator { src: op }
}
/// Walk a dir in top down way: list current dir first and then list nested dir.
///
/// Refer to [`TopDownWalker`] for more about the behavior details.
pub fn walk_top_down(&self, path: &str) -> Result<DirStreamer> {
Ok(Box::new(TopDownWalker::new(Object::new(
self.src.inner(),
path,
))))
}
/// Walk a dir in bottom up way: list nested dir first and then current dir.
///
/// Refer to [`BottomUpWalker`] for more about the behavior details.
pub fn walk_bottom_up(&self, path: &str) -> Result<DirStreamer> {
Ok(Box::new(BottomUpWalker::new(Object::new(
self.src.inner(),
path,
))))
}
/// Remove the path and all nested dirs and files recursively.
///
/// **Use this function in cautions to avoid unexpected data loss.**
pub async fn remove_all(&self, path: &str) -> Result<()> {
let parent = self.src.object(path);
let meta = parent.metadata().await?;
if meta.mode() != ObjectMode::DIR {
return parent.delete().await;
}
let obs = self.walk_bottom_up(path)?;
obs.try_for_each(|v| async move {
debug!("deleting {}", v.path());
v.into_object().delete().await
})
.await
}
}