Struct b2_client::file::ListFileNamesBuilder

pub struct ListFileNamesBuilder<'a> { /* private fields */ }

A builder for a ListFileNames request.

Implementations

impl<'a> ListFileNamesBuilder<'a>

pub fn bucket_id(self, id: &'a str) -> Self

The bucket ID from which to list files.

pub fn start_file_name(self, file_name: impl Into<String>) -> Self

The file name with which to start the listing.

pub fn max_file_count(self, count: u16) -> Self

The maximum number of files to return.

The default is 100. The provided count will be clamped to a value between 1 and 10,000 inclusive.

A single transaction has a limit of 1,000 files; values greater than 1,000 will incur charges for multiple transactions.

If more than 10,000 files are needed, a new request must be made.

pub fn prefix(self, prefix: &'a str) -> Result<Self, FileNameValidationError>

Set the filename prefix to filter the file listing.

If not set, all files are matched.

See https://www.backblaze.com/b2/docs/b2_list_file_names.html for information on file prefixes and delimiters, and their interaction with each other.

pub fn delimiter(self, delimiter: char) -> Result<Self, FileNameValidationError>

Set the delimiter to use to simulate a hierarchical filesystem.

See https://www.backblaze.com/b2/docs/b2_list_file_names.html for information on file prefixes and delimiters, and their interaction with each other.

pub fn build(self) -> Result<ListFileNames<'a>, MissingData>

Build a ListFileNames request.

Returns an error if the bucket ID has not been set.

Trait Implementations

impl<'a> Default for ListFileNamesBuilder<'a>

fn default() -> ListFileNamesBuilder<'a>

Returns the “default value” for a type.