qubit-redact 0.8.1

Rule-driven redaction for fields, diagnostics, HTTP data, and Rust domain objects
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
71
72
73
74
75
76

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Immutable URI redaction policy.

use std::sync::Arc;

use super::UriFragmentPolicy;
use super::UriPathPolicy;
use super::internal::UriPolicyInner;

/// Immutable URI policy that delegates field decisions to the core policy.
///
/// # Examples
///
/// ```
/// use qubit_redact::RedactionPolicy;
/// use qubit_redact::formats::uri::UriPathPolicy;
///
/// let policy = RedactionPolicy::strict();
/// assert_eq!(policy.uri().path_policy(), UriPathPolicy::Redact);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UriPolicy {
    /// Shared immutable choices behind cheap policy clones.
    inner: Arc<UriPolicyInner>,
}

impl UriPolicy {
    /// Creates an immutable URI policy from validated component policies.
    ///
    /// # Parameters
    ///
    /// * `path_policy` - Visibility of URI paths.
    /// * `fragment_policy` - Visibility and classification of URI fragments.
    ///
    /// # Returns
    ///
    /// A shared immutable snapshot; cloning it does not copy component state.
    #[must_use]
    #[inline(always)]
    pub(crate) fn new(path_policy: UriPathPolicy, fragment_policy: UriFragmentPolicy) -> Self {
        Self {
            inner: Arc::new(UriPolicyInner {
                path_policy,
                fragment_policy,
            }),
        }
    }

    /// Returns the path handling policy.
    ///
    /// # Returns
    ///
    /// The immutable visibility policy for URI path components.
    #[must_use]
    #[inline(always)]
    pub fn path_policy(&self) -> UriPathPolicy {
        self.inner.path_policy
    }

    /// Returns the fragment handling policy.
    ///
    /// # Returns
    ///
    /// The immutable classification and visibility policy for URI fragments.
    #[must_use]
    #[inline(always)]
    pub fn fragment_policy(&self) -> UriFragmentPolicy {
        self.inner.fragment_policy
    }
}