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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade.
//! Definition helper for single-path provider requests.

/// Defines one facade-created request with a validated logical path.
macro_rules! path_request {
    ($name:ident, $options:ty) => {
        /// A facade-created request with a validated logical path.
        pub struct $name<'a> {
            /// Validated logical path borrowed for provider dispatch.
            path: &'a crate::path::Path,
            /// Facade-resolved operation options.
            options: $options,
        }

        impl<'a> $name<'a> {
            /// Creates this request inside the facade boundary.
            ///
            /// # Parameters
            /// - `path`: Validated logical resource path.
            /// - `options`: Facade-resolved operation options.
            ///
            /// # Returns
            /// A provider request borrowing `path` for the dispatch lifetime.
            #[inline]
            pub(crate) const fn new(path: &'a crate::path::Path, options: $options) -> Self {
                Self { path, options }
            }

            /// Returns the validated logical path.
            ///
            /// # Returns
            /// The request path validated by the facade.
            #[inline]
            #[must_use]
            pub const fn path(&self) -> &'a crate::path::Path {
                self.path
            }

            /// Returns the resolved operation options.
            ///
            /// # Returns
            /// The immutable facade-resolved options.
            #[inline]
            #[must_use]
            pub const fn options(&self) -> &$options {
                &self.options
            }
        }
    };
}

pub(in crate::spi::request) use path_request;