qubit-fs 0.2.0

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade tests.
//! A single configured filesystem limit.

/// A provider-declared limit for one filesystem property.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::metadata::FileSystemLimit;
///
/// assert!(matches!(FileSystemLimit::Unknown, FileSystemLimit::Unknown));
/// ```
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum FileSystemLimit {
    /// The provider cannot report a stable limit at construction time.
    Unknown,
    /// The limit dimension does not apply to this provider.
    NotApplicable,
    /// The provider imposes no finite limit at the `rs-fs` API layer.
    Unbounded,
    /// The inclusive maximum accepted value.
    Maximum(
        /// Inclusive maximum accepted value.
        u64,
    ),
}

impl FileSystemLimit {
    /// Returns the finite inclusive maximum, when one exists.
    #[inline]
    #[must_use]
    pub const fn maximum(self) -> Option<u64> {
        match self {
            Self::Maximum(maximum) => Some(maximum),
            Self::Unknown | Self::NotApplicable | Self::Unbounded => None,
        }
    }

    /// Returns whether `actual` exceeds a declared finite maximum.
    #[inline]
    #[must_use]
    pub const fn is_exceeded_by(self, actual: u64) -> bool {
        matches!(self, Self::Maximum(maximum) if actual > maximum)
    }
}