Type Alias opendal::operator_futures::FutureLister

source ·
pub type FutureLister<F> = OperatorFuture<OpList, Lister, F>;
Expand description

Future that generated by Operator::list_with or Operator::lister_with.

Users can add more options by public functions provided by this struct.

Aliased Type§

struct FutureLister<F> { /* private fields */ }

Implementations§

source§

impl<F: Future<Output = Result<Lister>>> FutureLister<F>

source

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

The limit passed to underlying service to specify the max results that could return per-request.

Users could use this to control the memory usage of list operation.

source

pub fn start_after(self, v: &str) -> Self

The start_after passes to underlying service to specify the specified key to start listing from.

source

pub fn recursive(self, v: bool) -> Self

The recursive is used to control whether the list operation is recursive.

  • If false, list operation will only list the entries under the given path.
  • If true, list operation will list all entries that starts with given path.

Default to false.

source

pub fn metakey(self, v: impl Into<FlagSet<Metakey>>) -> Self

Metakey is used to control which meta should be returned.

Lister will make sure the result for specified meta is known:

  • Some(v) means exist.
  • None means services doesn’t have this meta.

The default metakey is Metakey::Mode.

source

pub fn concurrent(self, v: usize) -> Self

Concurrent is used to control the number of concurrent stat requests.

If concurrent is set to <=1, the lister will perform stat requests sequentially.

The default concurrent is 1.