Struct ListOptions 

#[non_exhaustive]
pub struct ListOptions { /* private fields */ }

Options controlling directory or prefix listing.

Options are validated by crate::FileSystem::list before a provider session is opened. A page-size hint is bounded by the provider’s declared limit; max_depth and max_entries are caller-side safety bounds.

Examples

use qubit_fs::directory::{ListFilter, ListOptions};

let options = ListOptions::default()
    .with_page_size(Some(100))
    .with_max_depth(Some(2))
    .with_max_entries(Some(500))
    .with_filter(Some(ListFilter::Subtree("reports".to_owned())));
assert_eq!(options.page_size(), Some(100));
assert_eq!(options.max_depth(), Some(2));
assert_eq!(options.max_entries(), Some(500));
assert!(options.validate().is_ok());

Implementations

impl ListOptions

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

Returns a copy with recursive traversal replaced.

pub const fn recursive(&self) -> bool

Returns whether traversal recurses into child containers.

pub const fn with_symlink_policy(self, policy: SymlinkPolicy) -> Self

Returns a copy with the symbolic-link policy override replaced.

pub const fn symlink_policy_override(&self) -> Option<SymlinkPolicy>

Returns the optional symbolic-link policy override.

pub const fn with_include_metadata(self, include: bool) -> Self

Returns a copy with metadata inclusion replaced.

pub const fn include_metadata(&self) -> bool

Returns whether metadata is requested for entries.

pub const fn with_page_size(self, page_size: Option<usize>) -> Self

Returns a copy with the page-size hint replaced.

pub const fn page_size(&self) -> Option<usize>

Returns the optional page-size hint.

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

Returns a copy with the lexical prefix replaced.

pub fn prefix(&self) -> Option<&str>

Returns the optional lexical prefix.

Returns

Some with the configured subtree prefix, or None when no subtree prefix filter is configured.

pub fn with_filter(self, filter: Option<ListFilter>) -> Self

Replaces the explicit listing filter.

pub fn filter(&self) -> Option<&ListFilter>

Returns the explicit listing filter.

Returns

Some with the configured filter, or None when listing is unfiltered.

pub fn object_keys() -> Self

Returns defaults for a flat object-key listing.

pub const fn with_max_depth(self, max_depth: Option<usize>) -> Self

Returns a copy with the maximum descendant depth replaced.

pub const fn max_depth(&self) -> Option<usize>

Returns the optional maximum descendant depth.

pub const fn with_max_entries(self, max_entries: Option<usize>) -> Self

Returns a copy with the maximum returned entry count replaced.

pub const fn max_entries(&self) -> Option<usize>

Returns the optional maximum returned entry count.

pub const fn with_deadline(self, deadline: Option<Duration>) -> Self

Returns a copy with the maximum elapsed duration replaced.

pub const fn deadline(&self) -> Option<Duration>

Returns the optional maximum elapsed duration from stream creation.

pub fn validate(&self) -> FsResult<()>

Validates pagination and canonical provider-facing prefix values.

Errors

Returns an invalid-options error when the page size is zero or the prefix is not a canonical relative path.

pub fn validate_for(&self, semantics: PathSemantics) -> FsResult<()>

Validates options against the filesystem path semantics.

Parameters

• semantics: Provider path semantics used to validate the filter.

Errors

Returns an invalid-options error when the configured filter is not representable under semantics.

Trait Implementations

impl Clone for ListOptions

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl Default for ListOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ListOptions

impl PartialEq for ListOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ListOptions