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 walk(&self, path: &str) -> Result<ObjectLister>

Walk a dir in the best way that suitable for underlying storage.

The returning order could be differ for different underlying storage. And could be changed at any time. Users MUST NOT relay on the order.

pub fn walk_top_down(&self, path: &str) -> Result<ObjectLister>

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_bottom_up(&self, path: &str) -> Result<ObjectLister>

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 async fn remove_all(&self, path: &str) -> Result<()>

Remove the path and all nested dirs and files recursively.

Use this function in cautions to avoid unexpected data loss.

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.