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
108
109
110
111
112
// =============================================================================
// Copyright (c) 2025 - 2026 Haixing Hu.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Hard input and output limits for redacted diagnostics.
use super::{
DiagnosticBudgetError,
DiagnosticInputBudget,
};
/// Bounds both inspected diagnostic bytes and produced log-safe bytes.
#[must_use]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DiagnosticBudget {
/// Maximum number of source bytes a diagnostic redactor may inspect.
max_input_bytes: usize,
/// Maximum number of bytes in the final log-safe rendering.
max_output_bytes: usize,
}
impl DiagnosticBudget {
/// Smallest output limit that can contain the diagnostic-limit marker.
pub const MIN_OUTPUT_BYTES: usize =
"<redacted: diagnostic limit exceeded>".len();
/// Creates checked hard limits for diagnostic processing.
///
/// # Parameters
///
/// * `max_input_bytes` - Maximum source bytes one diagnostic may inspect.
/// * `max_output_bytes` - Maximum bytes in the final log-safe rendering.
///
/// # Returns
///
/// A validated diagnostic budget.
///
/// # Errors
///
/// Returns [`DiagnosticBudgetError::ZeroInput`] when `max_input_bytes` is
/// zero, or [`DiagnosticBudgetError::OutputTooSmall`] when the output limit
/// cannot contain the diagnostic-limit marker.
#[inline]
pub const fn new(
max_input_bytes: usize,
max_output_bytes: usize,
) -> Result<Self, DiagnosticBudgetError> {
if max_input_bytes == 0 {
return Err(DiagnosticBudgetError::ZeroInput);
}
if max_output_bytes < Self::MIN_OUTPUT_BYTES {
return Err(DiagnosticBudgetError::OutputTooSmall {
minimum: Self::MIN_OUTPUT_BYTES,
actual: max_output_bytes,
});
}
Ok(Self {
max_input_bytes,
max_output_bytes,
})
}
/// Returns the maximum number of source bytes a diagnostic may inspect.
///
/// # Returns
///
/// The configured source-byte limit.
#[must_use]
#[inline(always)]
pub const fn max_input_bytes(self) -> usize {
self.max_input_bytes
}
/// Returns the maximum final log-safe diagnostic size.
///
/// # Returns
///
/// The configured output-byte limit.
#[must_use]
#[inline(always)]
pub const fn max_output_bytes(self) -> usize {
self.max_output_bytes
}
/// Creates independent input accounting for one diagnostic rendering.
///
/// # Returns
///
/// A mutable budget initialized from this diagnostic's input limit.
#[inline(always)]
pub const fn input_budget(self) -> DiagnosticInputBudget {
DiagnosticInputBudget::new(self.max_input_bytes)
}
}
impl Default for DiagnosticBudget {
/// Returns conservative 16 KiB input and 64 KiB output limits.
///
/// # Returns
///
/// A diagnostic budget with the documented conservative limits.
#[inline(always)]
fn default() -> Self {
Self {
max_input_bytes: 16 * 1024,
max_output_bytes: 64 * 1024,
}
}
}