Struct opendal::BatchOperator

pub struct BatchOperator { /* private fields */ }

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.

Implementations

impl BatchOperator

pub fn with_limit(self, limit: usize) -> Self

Specify the batch limit.

Default: 1000

pub async fn remove(&self, paths: Vec<String>) -> Result<()>

remove will given paths.

Notes

If underlying services support delete in batch, we will use batch delete instead.

Examples

op.batch()
    .remove(vec!["abc".to_string(), "def".to_string()])
    .await?;

pub async fn remove_via( &self, input: impl Stream<Item = String> + Unpin ) -> Result<()>

remove_via will remove objects via given stream.

We will delete by chunks with given batch limit on the stream.

Notes

If underlying services support delete in batch, we will use batch delete instead.

Examples

use futures::stream;
let stream = stream::iter(vec!["abc".to_string(), "def".to_string()]);
op.batch().remove_via(stream).await?;

pub async fn remove_all(&self, path: &str) -> Result<()>

Remove the path and all nested dirs and files recursively.

Notes

If underlying services support delete in batch, we will use batch delete instead.

Examples

op.batch().remove_all("path/to/dir").await?;

Trait Implementations

impl Clone for BatchOperator

fn clone(&self) -> BatchOperator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchOperator

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

Formats the value using the given formatter.