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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Validated byte limits for bounded log output.

use crate::{
    InputOutputLimit,
    LogOutputLimitError,
};

/// Marker appended when bounded log output is truncated.
pub(crate) const TRUNCATION_MARKER: &str = "<truncated>";

/// Maximum byte count for one bounded redacted log representation.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[must_use = "use the validated limit to bound redacted display output"]
pub struct LogOutputLimit {
    /// Maximum rendered bytes, including any truncation marker.
    max_bytes: usize,
}

impl LogOutputLimit {
    /// Smallest valid limit, equal to the byte length of the truncation marker.
    pub const MINIMUM: usize = TRUNCATION_MARKER.len();

    /// Validates a maximum output byte count.
    ///
    /// # Parameters
    ///
    /// * `max_bytes` - Maximum rendered bytes, including any truncation marker.
    ///
    /// # Returns
    ///
    /// A validated output limit.
    ///
    /// # Errors
    ///
    /// Returns [`LogOutputLimitError`] when `max_bytes` cannot contain the
    /// complete truncation marker.
    #[inline]
    pub const fn new(max_bytes: usize) -> Result<Self, LogOutputLimitError> {
        if max_bytes < Self::MINIMUM {
            Err(LogOutputLimitError::new(max_bytes))
        } else {
            Ok(Self { max_bytes })
        }
    }

    /// Returns the maximum rendered byte count.
    ///
    /// # Returns
    ///
    /// The byte budget, including any truncation marker.
    #[inline(always)]
    pub const fn max_bytes(self) -> usize {
        self.max_bytes
    }
}

impl From<InputOutputLimit> for LogOutputLimit {
    /// Converts a diagnostic budget into its compatible log-output limit.
    ///
    /// [`InputOutputLimit`] guarantees an output bound large enough for every
    /// [`LogOutputLimit`].
    ///
    /// # Parameters
    ///
    /// * `budget` - Diagnostic budget whose output limit is converted.
    ///
    /// # Returns
    ///
    /// A compatible validated log-output limit.
    #[inline(always)]
    fn from(budget: InputOutputLimit) -> Self {
        Self {
            max_bytes: budget.max_output_bytes(),
        }
    }
}