Struct ListBlobsRequest

pub struct ListBlobsRequest {
    pub include_dirs: bool,
    pub extensions: HashSet<String>,
    pub excluded: HashSet<String>,
    pub prefix: Option<String>,
}

Represents the request options for querying blobs from a storage service.

Fields

include_dirs: bool

Whether if the response should include directory blobs or not. If this set to false, then it will only include file blobs in the given directory where the request is being processed.

extensions: HashSet<String>

A list of extensions to filter for. By default, this will include all file extensions if no entries exist.

excluded: HashSet<String>

List of file names to exclude from the returned entry. This can exclude directories with the dir: prefix.

prefix: Option<String>

Optional prefix to set when querying for blobs.

Implementations

impl ListBlobsRequest

pub fn exclude<'a, I: Iterator<Item = &'a str>>(self, items: I) -> Self

Appends a slice of strings to exclude from.

pub fn with_prefix<I: Into<String>>(self, prefix: Option<I>) -> Self

Sets a prefix to this request.

pub fn with_extensions<'a, I: Iterator<Item = &'a str>>(self, exts: I) -> Self

Appends a list of extensions that can be use to filter files from in the given directory that items were found.

pub fn with_include_dirs(&mut self, yes: bool) -> &mut Self

Whether if the response should include directory blobs or not. If this set to false, then it will only include file blobs in the given directory where the request is being processed.

pub fn is_excluded<I: AsRef<str>>(&self, item: I) -> bool

Checks if the given item is excluded or not.

Example

let mut req = ListBlobsRequest::default();
let _ = req.clone().exclude(&["hello.txt"]);

assert!(!req.is_excluded("world.txt"));
assert!(req.is_excluded("hello.txt"));

pub fn is_ext_allowed<I: AsRef<str>>(&self, ext: I) -> bool

Checks if an extension is allowed. If the configured extensions to return is empty, then this will always return true. Otherwise, it will try to check if it exists or not.

Example

let mut req = ListBlobsRequest::default();
let _ = req.clone().extensions(&[".txt"]);

assert!(!req.is_ext_allowed(".json"));
assert!(req.is_ext_allowed(".txt"));

let req = ListBlobsRequest::default();
assert!(req.is_ext_allowed(".json"));

Trait Implementations

impl Clone for ListBlobsRequest

fn clone(&self) -> ListBlobsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListBlobsRequest

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

Formats the value using the given formatter.

impl Default for ListBlobsRequest

fn default() -> ListBlobsRequest

Returns the “default value” for a type.