qubit-redact 0.9.0

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// qubit-style: allow source-test-pair
//! Construction state for one HTTP field-policy context.

use crate::PolicyError;
use crate::PolicyLocation;
use crate::RedactionFloor;
use crate::RedactionRules;
use crate::policy::RedactionRulesBuilder;

/// Construction state for a single HTTP field context.
#[derive(Debug, Clone)]
pub(super) struct ContextRulesBuilder {
    /// Mutable application rules for this HTTP field namespace.
    pub(super) rules: RedactionRulesBuilder,
    /// Optional minimum floor applied after application rules.
    pub(super) floor: Option<RedactionFloor>,
}

impl ContextRulesBuilder {
    /// Creates empty context overrides.
    ///
    /// # Parameters
    ///
    /// - `location`: HTTP context attached to subsequent validation errors.
    ///
    /// # Returns
    ///
    /// An empty application rule builder with no minimum floor.
    #[must_use]
    #[inline]
    pub(super) fn empty(location: PolicyLocation) -> Self {
        Self {
            rules: RedactionRulesBuilder::empty(location),
            floor: None,
        }
    }

    /// Copies an immutable rules snapshot while assigning validation location.
    ///
    /// # Parameters
    ///
    /// - `rules`: Immutable application rules and optional floor to copy.
    /// - `location`: HTTP context attached to subsequent validation errors.
    ///
    /// # Returns
    ///
    /// An independent mutable builder initialized from the supplied snapshot.
    #[must_use]
    #[inline]
    pub(super) fn from_rules(rules: &RedactionRules, location: PolicyLocation) -> Self {
        Self {
            rules: RedactionRulesBuilder::from_inner(&rules.clone_application(), location),
            floor: rules.floor().cloned(),
        }
    }

    /// Replaces the floor snapshot.
    ///
    /// # Parameters
    ///
    /// - `floor`: Immutable minimum protection floor to install.
    #[inline]
    pub(super) fn with_floor(&mut self, floor: RedactionFloor) {
        self.floor = Some(floor);
    }

    /// Disables the floor snapshot.
    #[inline(always)]
    pub(super) fn disable_floor(&mut self) {
        self.floor = None;
    }

    /// Builds the immutable rules snapshot.
    ///
    /// # Returns
    ///
    /// The application rules and optional floor as one immutable snapshot.
    ///
    /// # Errors
    ///
    /// Currently always succeeds because individual rule setters validate
    /// their inputs before storing them.
    #[inline]
    pub(super) fn build(self) -> Result<RedactionRules, PolicyError> {
        Ok(RedactionRules::new(self.rules.build_inner()?, self.floor))
    }
}