qubit-fs 0.2.2

Provider-neutral synchronous and asynchronous filesystem abstraction for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade tests.
//! Synchronous directory operation implementation.

use crate::FileSystem;
use crate::directory::DirectoryStream;
use crate::directory::ListOptions;
use crate::directory::ListScope;
use crate::error::FsOperation;
use crate::error::FsResult;
use crate::metadata::FileSystemCapability;
use crate::spi::ListRequest;
use crate::spi::ResolvedListOptions;

/// Executes synchronous directory operations for one facade.
pub(crate) struct DirectoryOperation<'a> {
    /// Facade that validates and dispatches the operation.
    filesystem: &'a FileSystem,
}

impl<'a> DirectoryOperation<'a> {
    /// Creates a directory operation bound to `filesystem`.
    #[inline]
    pub(crate) const fn new(filesystem: &'a FileSystem) -> Self {
        Self { filesystem }
    }

    /// Opens a provider directory stream after local option validation.
    pub(crate) fn list(&self, scope: &ListScope, options: ListOptions) -> FsResult<DirectoryStream> {
        crate::directory::internal::list_preflight::validate(self.filesystem.properties(), scope, &options)
            .map_err(|error| self.filesystem.core().enrich(error, scope.path(), FsOperation::List))?;
        self.filesystem
            .core()
            .require(FileSystemCapability::List, FsOperation::List, scope.path())?;
        let page_size = self
            .filesystem
            .properties()
            .limits()
            .clamp_list_page_size(options.page_size());
        let options = options.with_page_size(page_size);
        self.filesystem
            .spi()
            .list(ListRequest::new(
                scope,
                ResolvedListOptions::new(
                    options.clone(),
                    options
                        .symlink_policy_override()
                        .unwrap_or(self.filesystem.properties().symlink_policy()),
                ),
            ))
            .and_then(|opened| {
                DirectoryStream::new(
                    scope.clone(),
                    opened.into_stream(),
                    options,
                    self.filesystem.properties().info().provider_id(),
                    self.filesystem.properties().info().path_semantics(),
                    *self.filesystem.properties().limits(),
                )
            })
            .map_err(|error| self.filesystem.core().enrich(error, scope.path(), FsOperation::List))
    }
}