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
37
38
39
40
41
42
43
44
45
46

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Errors raised when resolving a batch capability.

use std::error::Error;
use std::fmt;

/// Error returned when a batch output cannot resolve a handle.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[must_use]
pub(crate) enum DiagnosticRedactionHandleError {
    /// The handle was created by a different batch.
    DifferentBatch,
    /// The handle index is outside the published batch item range.
    MissingItem,
}

impl fmt::Display for DiagnosticRedactionHandleError {
    /// Renders a stable diagnostic that contains no protected text.
    ///
    /// # Parameters
    ///
    /// - `formatter`: Destination receiving a value-free failure description.
    ///
    /// # Returns
    ///
    /// Success after writing the diagnostic.
    ///
    /// # Errors
    ///
    /// Propagates a destination formatting error.
    #[inline]
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(match self {
            Self::DifferentBatch => "the handle belongs to a different batch",
            Self::MissingItem => "the handle does not identify a published item",
        })
    }
}

impl Error for DiagnosticRedactionHandleError {}