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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Completion state shared by redaction operations.

/// Describes whether a redaction operation produced all required safe output.
///
/// # Examples
///
/// ```
/// use qubit_redact::{RedactionCompletion, Redactor};
///
/// let output = Redactor::standard().redact_field("password", "raw-secret");
/// assert_eq!(output.summary().completion(), RedactionCompletion::Complete);
/// ```
#[must_use]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RedactionCompletion {
    /// All input was processed and its complete safe output fit the budget.
    ///
    /// An ordinary sensitivity mask is a complete result, not truncation.
    Complete,
    /// Input or output was omitted, but non-empty safe substitute text was
    /// emitted.
    Truncated,
    /// The shared output budget could not retain a complete safe replacement.
    Exhausted,
}