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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Failure facts independent of output capacity and publication.

use crate::RedactionReason;

/// Distinguishes a rejected capture write from a formatter's own error.
#[must_use]
pub(in crate::runtime) enum ScalarFailure {
    /// A submitted UTF-8 chunk did not fit the remaining input allowance.
    InputLimit,
    /// Formatting returned an error without any rejected capture write.
    FormatterFailure,
}

impl ScalarFailure {
    /// Returns the observed failure's provenance without inferring output
    /// state.
    ///
    /// # Returns
    ///
    /// The input-limit or formatting-failure reason represented by this value.
    #[must_use]
    #[inline(always)]
    pub(in crate::runtime) const fn reason(&self) -> RedactionReason {
        match self {
            Self::InputLimit => RedactionReason::InputLimitReached,
            Self::FormatterFailure => RedactionReason::FormattingFailed,
        }
    }
}