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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Immutable policy snapshot for every HTTP redaction context.

use std::sync::Arc;

use super::TextBodyPolicy;
use super::UrlPathPolicy;
use super::internal::HttpPolicyParts;
use crate::RedactionRules;

/// Combines HTTP field rules and rendering choices.
///
/// Resource limits belong to the enclosing [`crate::RedactionPolicy`].
///
/// # Examples
///
/// ```
/// use qubit_redact::RedactionPolicy;
/// use qubit_redact::formats::http::UrlPathPolicy;
///
/// let policy = RedactionPolicy::standard();
/// assert_eq!(policy.http().url_path_policy(), UrlPathPolicy::Preserve);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct HttpPolicy {
    /// Shared immutable context policies behind cheap policy clones.
    inner: Arc<HttpPolicyParts>,
}

impl HttpPolicy {
    /// Creates an HTTP policy from its validated component policies.
    ///
    /// # Parameters
    ///
    /// * `parts` - Validated context rules and rendering choices to own.
    ///
    /// # Returns
    ///
    /// An immutable snapshot whose clones share the same Arc payload.
    #[must_use]
    #[inline(always)]
    pub(super) fn from_parts(parts: HttpPolicyParts) -> Self {
        Self { inner: Arc::new(parts) }
    }

    /// Returns the header field-rule snapshot.
    ///
    /// # Returns
    ///
    /// Borrowed classification rules for HTTP header names.
    #[must_use]
    #[inline(always)]
    pub fn header_rules(&self) -> &RedactionRules {
        &self.inner.header_rules
    }

    /// Returns the query and form field-rule snapshot.
    ///
    /// # Returns
    ///
    /// Borrowed classification rules shared by query and form fields.
    #[must_use]
    #[inline(always)]
    pub fn query_rules(&self) -> &RedactionRules {
        &self.inner.query_rules
    }

    /// Returns the structured-body field-rule snapshot.
    ///
    /// # Returns
    ///
    /// Borrowed classification rules for structured body fields.
    #[must_use]
    #[inline(always)]
    pub fn body_rules(&self) -> &RedactionRules {
        &self.inner.body_rules
    }

    /// Returns the URL path visibility choice.
    ///
    /// # Returns
    ///
    /// The immutable URL-path visibility policy.
    #[must_use]
    #[inline(always)]
    pub fn url_path_policy(&self) -> UrlPathPolicy {
        self.inner.url_path_policy
    }

    /// Returns the opaque text-body visibility choice.
    ///
    /// # Returns
    ///
    /// The immutable visibility policy for opaque text bodies.
    #[must_use]
    #[inline(always)]
    pub fn text_body_policy(&self) -> TextBodyPolicy {
        self.inner.text_body_policy
    }
}