Enum ListScope 

#[non_exhaustive]
pub enum ListScope {
    Path(Path),
    Namespace,
}

Selects the portion of one configured filesystem to enumerate.

A flat Path scope is a raw key prefix. A hierarchical path denotes a directory. Namespace is available only for flat path semantics and never expands beyond the configured filesystem.

Examples

use qubit_fs::Path;
use qubit_fs::directory::ListScope;
let scope = ListScope::Path(Path::parse_literal("reports/")?);
assert_eq!(scope.path().map(Path::as_str), Some("reports/"));
assert!(ListScope::Namespace.path().is_none());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Path(Path)

Enumerates a directory or raw key prefix using its existing path rules.

Namespace

Enumerates the entire configured flat namespace without an empty path.

Implementations

impl ListScope

pub const fn path(&self) -> Option<&Path>

Returns the resource prefix, or None for a whole namespace query.

Trait Implementations

impl Clone for ListScope

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 ListScope

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

Formats the value using the given formatter.

impl Eq for ListScope

impl PartialEq for ListScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ListScope