Skip to main content

ListOptions

Struct ListOptions 

Source
pub struct ListOptions {
Show 25 fields pub all: bool, pub almost_all: bool, pub sort_by: SortBy, pub reverse: bool, pub dirs_first: bool, pub recursive: bool, pub max_depth: Option<usize>, pub gnu_mode: bool, pub follow_links: bool, pub directory: bool, pub ignore_backups: bool, pub ignore_patterns: Vec<String>, pub hide_patterns: Vec<String>, pub use_ignore_files: bool, pub list_archives: bool, pub time_field: TimeField, pub cli_symlink: CliSymlinkMode, pub parallel: bool, pub threads: usize, pub collect_timing: bool, pub resolve_owner_group: bool, pub read_selinux: bool, pub linux_statx: bool, pub io_uring: bool, pub emit_dir_headers: bool,
}
Expand description

Options controlling which entries appear and how they are ordered.

Fields§

§all: bool§almost_all: bool§sort_by: SortBy§reverse: bool§dirs_first: bool§recursive: bool§max_depth: Option<usize>§gnu_mode: bool

Stricter GNU-compatible behavior.

§follow_links: bool

Follow symlinks when stating (-L).

§directory: bool

List directories themselves, not contents (-d).

§ignore_backups: bool

Hide *~ backup names (-B).

§ignore_patterns: Vec<String>

Shell-style ignore patterns (-I / --ignore); always hidden.

§hide_patterns: Vec<String>

Shell-style hide patterns (--hide); hidden unless -a/-A.

§use_ignore_files: bool

When true, honor .gitignore / .f00ignore in listed directories.

§list_archives: bool

When true, list inside zip/tar archives when a path is an archive file. (Applied by callers that integrate f00-archive; core itself does not open archives.)

§time_field: TimeField

Which timestamp to sort/display by.

§cli_symlink: CliSymlinkMode

How CLI path arguments that are symlinks are handled.

§parallel: bool

Parallelize metadata (stat) for large directories (rayon). Forced off when Self::threads is 1.

§threads: usize

Rayon worker count: 0 = auto, 1 = force serial, N>1 = fixed pool size.

§collect_timing: bool

When true, fill crate::Listing::timing with phase durations.

§resolve_owner_group: bool

Resolve uid/gid to owner/group names (expensive NSS). Off for short listings.

§read_selinux: bool

Read SELinux context xattr (-Z). Off unless requested.

§linux_statx: bool

Prefer Linux statx for metadata when available (ignored on other OSes).

§io_uring: bool

Prefer io_uring batch statx for large directories when the io-uring cargo feature is enabled (Linux only; ignored otherwise).

§emit_dir_headers: bool

Emit synthetic directory section headers in recursive listings (-R). Off for --tree (headers are not used and cost extra work).

Implementations§

Source§

impl ListOptions

Source

pub fn use_parallel_stat(&self, entry_count: usize) -> bool

Whether metadata should use rayon for this listing size.

Trait Implementations§

Source§

impl Clone for ListOptions

Source§

fn clone(&self) -> ListOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ListOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ListOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.