Struct ListOptions 

pub struct ListOptions {
    pub recursive: bool,
    pub include_hidden: bool,
    pub files_only: bool,
    pub directories_only: bool,
    pub pattern: Option<String>,
    pub limit: usize,
    pub sort_by: SortBy,
}

Options for listing files and directories.

Fields

recursive: bool

include_hidden: bool

files_only: bool

directories_only: bool

pattern: Option<String>

limit: usize

sort_by: SortBy

Implementations

impl ListOptions

pub fn with_recursive(self, recursive: bool) -> ListOptions

Returns options with recursive traversal enabled or disabled.

Panics

This method does not panic.

pub fn with_include_hidden(self, include_hidden: bool) -> ListOptions

Returns options with hidden files included or excluded.

Panics

This method does not panic.

pub fn with_files_only(self, files_only: bool) -> ListOptions

Returns options with files-only filtering enabled or disabled.

Panics

This method does not panic.

pub fn with_directories_only(self, directories_only: bool) -> ListOptions

Returns options with directories-only filtering enabled or disabled.

Panics

This method does not panic.

pub fn with_pattern(self, pattern: Option<String>) -> ListOptions

Returns options with an optional name pattern filter.

Panics

This method does not panic.

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

Returns options with the listing limit updated.

Panics

This method does not panic.

pub fn with_sort_by(self, sort_by: SortBy) -> ListOptions

Returns options with the sort key updated.

Panics

This method does not panic.

Trait Implementations

impl Clone for ListOptions

fn clone(&self) -> ListOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListOptions

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

Formats the value using the given formatter.

impl Default for ListOptions

fn default() -> ListOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<ListOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.