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
107

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Transactional view over HTTP policy contexts.

use super::HttpContextBuilderView;
use super::PolicyError;
use super::RedactionFloor;
use super::RedactionPolicyBuilder;

/// Mutable view over all HTTP context differences.
///
/// # Examples
///
/// ```
/// use qubit_redact::RedactionPolicy;
/// use qubit_redact::formats::http::UrlPathPolicy;
///
/// let policy = RedactionPolicy::builder().http(|http| {
///     http.url_path(UrlPathPolicy::Redact);
/// })?.build()?;
/// assert!(!policy.is_disabled());
/// # Ok::<(), qubit_redact::PolicyError>(())
/// ```
#[cfg(feature = "http")]
pub struct HttpPolicyBuilderView<'a> {
    /// Root builder receiving HTTP policy changes.
    pub(super) builder: &'a mut RedactionPolicyBuilder,
    /// First validation error recorded by the transactional view.
    pub(super) error: Option<PolicyError>,
}

#[cfg(feature = "http")]
impl HttpPolicyBuilderView<'_> {
    /// Returns the header context view.
    #[must_use]
    #[inline(always)]
    pub fn header(&mut self) -> HttpContextBuilderView<'_> {
        HttpContextBuilderView {
            builder: &mut self.builder.http,
            error: &mut self.error,
            context: crate::formats::http::HttpFieldContext::Header,
        }
    }

    /// Returns the query/form context view.
    #[must_use]
    #[inline(always)]
    pub fn query(&mut self) -> HttpContextBuilderView<'_> {
        HttpContextBuilderView {
            builder: &mut self.builder.http,
            error: &mut self.error,
            context: crate::formats::http::HttpFieldContext::Query,
        }
    }

    /// Returns the structured-body context view.
    #[must_use]
    #[inline(always)]
    pub fn body(&mut self) -> HttpContextBuilderView<'_> {
        HttpContextBuilderView {
            builder: &mut self.builder.http,
            error: &mut self.error,
            context: crate::formats::http::HttpFieldContext::Body,
        }
    }

    /// Sets URL path visibility for HTTP diagnostics.
    #[inline(always)]
    pub fn url_path(&mut self, policy: crate::formats::http::UrlPathPolicy) -> &mut Self {
        self.builder.http.url_path_mut(policy);
        self
    }

    /// Sets opaque text-body visibility for HTTP diagnostics.
    #[inline(always)]
    pub fn text_body(&mut self, policy: crate::formats::http::TextBodyPolicy) -> &mut Self {
        self.builder.http.text_body_mut(policy);
        self
    }

    /// Sets the same floor for every HTTP field context.
    #[inline(always)]
    pub fn floor_all(&mut self, floor: RedactionFloor) -> &mut Self {
        self.builder.http.floor_all_mut(floor);
        self
    }

    /// Disables every HTTP field-context floor explicitly.
    #[inline(always)]
    pub fn disable_all_floors(&mut self) -> &mut Self {
        self.builder.http.disable_all_floors_mut();
        self
    }

    /// Sets the handling of root and array JSON scalar values in HTTP
    /// bodies.
    #[inline(always)]
    pub fn unkeyed_json(&mut self, policy: crate::UnkeyedJsonValuePolicy) -> &mut Self {
        self.builder.unkeyed_json_value_policy = policy;
        self
    }
}