qubit-redact 0.4.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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Parser output shared by HTTP body redaction helpers.

use crate::http::BodyRedactionStatus;

/// Unescaped parser output paired with its body-redaction status.
#[must_use]
pub(in crate::http) struct ParsedBody {
    /// Redacted text before final log escaping.
    text: String,
    /// How the parser processed the body.
    status: BodyRedactionStatus,
    /// Whether bounded structured rendering omitted output.
    rendered_truncated: bool,
}

impl ParsedBody {
    /// Creates parser output with its final rendering-truncation state.
    ///
    /// # Parameters
    ///
    /// * `text` - Redacted text before final log escaping.
    /// * `status` - How the parser processed the body.
    /// * `rendered_truncated` - Whether structured rendering omitted output.
    ///
    /// # Returns
    ///
    /// One complete parser result.
    #[inline(always)]
    pub(in crate::http) const fn new(
        text: String,
        status: BodyRedactionStatus,
        rendered_truncated: bool,
    ) -> Self {
        Self {
            text,
            status,
            rendered_truncated,
        }
    }

    /// Separates the parser result into its rendering components.
    ///
    /// # Returns
    ///
    /// The redacted text, body-redaction status, and rendering-truncation flag,
    /// in that order.
    #[inline(always)]
    pub(in crate::http) fn into_parts(
        self,
    ) -> (String, BodyRedactionStatus, bool) {
        (self.text, self.status, self.rendered_truncated)
    }
}