qubit-fs 0.2.1

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Portable symbolic-link resolution policies.

/// Controls whether a filesystem may resolve symbolic links while operating
/// within its configured namespace.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::metadata::SymlinkPolicy;
///
/// assert!(matches!(SymlinkPolicy::Reject, SymlinkPolicy::Reject));
/// ```
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
#[must_use]
#[non_exhaustive]
pub enum SymlinkPolicy {
    /// Reject an operation that requires symbolic-link resolution.
    #[default]
    Reject,
    /// Follow symbolic links only when the resolved target remains inside the
    /// configured filesystem namespace.
    FollowWithinFileSystem,
}

impl SymlinkPolicy {
    /// Returns whether this policy permits symbolic-link resolution.
    #[inline]
    #[must_use]
    pub const fn follows(self) -> bool {
        matches!(self, Self::FollowWithinFileSystem)
    }
}