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
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) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Log-safe rendering of a redacted argument vector.

use std::{
    borrow::Cow,
    fmt::{
        self,
        Display,
        Formatter,
    },
};

use crate::{
    InputOutputLimit,
    LogSafeText,
};

use super::redacted_argv_builder::RedactedArgvBuilder;

/// A redacted argv rendering that is safe for a single-line text log.
#[must_use = "render the redacted argv instead of the original arguments"]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RedactedArgv {
    /// Escaped debug-style rendering of all argument tokens.
    rendered: LogSafeText<'static>,
}

impl RedactedArgv {
    /// Creates a bounded argv rendering builder for one diagnostic budget.
    ///
    /// # Parameters
    ///
    /// * `budget` - Input and output limits for the diagnostic rendering.
    ///
    /// # Returns
    ///
    /// An empty byte-bounded argv rendering builder.
    #[inline]
    pub(super) fn builder(budget: InputOutputLimit) -> RedactedArgvBuilder {
        RedactedArgvBuilder::new(budget)
    }

    /// Creates an argv value from already escaped bounded output.
    ///
    /// # Parameters
    ///
    /// * `rendered` - Escaped debug-style argv rendering.
    ///
    /// # Returns
    ///
    /// A displayable argv value.
    #[inline(always)]
    pub(super) fn from_rendered(rendered: String) -> Self {
        Self {
            rendered: LogSafeText::from_escaped(Cow::Owned(rendered)),
        }
    }

    /// Borrows the already escaped diagnostic representation.
    ///
    /// The returned text is safe to append through
    /// [`crate::DiagnosticLogBuilder::push_safe`]. Callers remain responsible
    /// for applying any enclosing output budget.
    #[inline(always)]
    pub const fn as_log_safe_text(&self) -> &LogSafeText<'static> {
        &self.rendered
    }
}

impl Display for RedactedArgv {
    /// Writes the complete escaped argv rendering.
    ///
    /// # Parameters
    ///
    /// * `formatter` - Destination formatting context.
    ///
    /// # Returns
    ///
    /// The formatter result from writing the complete rendering.
    ///
    /// # Errors
    ///
    /// Returns [`fmt::Error`] when the destination formatter rejects output.
    #[inline(always)]
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.rendered, formatter)
    }
}