qubit-redact 0.9.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
84
85

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Public transactional API surface checks.

use qubit_redact::DiagnosticRedactionBatch;
use qubit_redact::DiagnosticRedactionHandle;
use qubit_redact::DiagnosticRedactionOutput;
use qubit_redact::Redact;
use qubit_redact::RedactedText;
use qubit_redact::RedactedTextComposer;
use qubit_redact::RedactionCompletion;
use qubit_redact::RedactionPolicy;
use qubit_redact::RedactionSummary;
use qubit_redact::RedactionTextOutput;
use qubit_redact::RedactionUsage;
use qubit_redact::RedactionWriter;
use qubit_redact::Redactor;
use qubit_redact::domain::RedactionEntries;
use qubit_redact::domain::RedactionFields;
use qubit_redact::domain::RedactionItems;

/// Proves the target public types are available through the crate root.
#[test]
fn target_transactional_types_are_public() {
    fn assert_redact<T: Redact + ?Sized>() {}
    let _ = assert_redact::<PublicApiValue>;
    let _: Option<RedactionFields<'_, '_>> = None;
    let _: Option<RedactionItems<'_, '_>> = None;
    let _: Option<RedactionEntries<'_, '_>> = None;
    let _: Option<RedactedText> = None;
    let _: Option<RedactedTextComposer> = None;
    let _: Option<DiagnosticRedactionBatch> = None;
    let _: Option<DiagnosticRedactionOutput> = None;
    let _: Option<DiagnosticRedactionHandle> = None;
    let _: Option<RedactionCompletion> = None;
    let _: Option<RedactionTextOutput> = None;
    let _: Option<RedactionPolicy> = None;
    let _: Option<RedactionSummary> = None;
    let _: Option<RedactionUsage> = None;
    let _: Option<Redactor> = None;
}

#[test]
fn batch_resolves_independent_items_without_aggregate_text() {
    let mut batch = Redactor::strict().diagnostic_batch();
    let handle = batch.redact_field("password", "raw-secret");
    let output = batch.finish_with_marker("<redaction incomplete>");

    assert_eq!(output.text(handle).as_str(), "<redacted>");
    assert_eq!(output.summary().completion(), RedactionCompletion::Complete);
}

#[test]
fn batch_redacts_one_domain_value() {
    let mut batch = Redactor::strict().diagnostic_batch();
    let handle = batch.redact_value(&PublicApiValue);
    let output = batch.finish_with_marker("<redaction incomplete>");

    assert_eq!(output.text(handle).as_str(), "PublicApiValue");
}

#[test]
fn text_composer_builds_one_ordered_text() {
    let output = Redactor::strict()
        .text_composer()
        .literal("password=")
        .field("password", "raw-secret")
        .finish();

    assert_eq!(output.text().as_str(), "password=<redacted>");
}

/// Minimal type used only to prove the public trait is implementable.
struct PublicApiValue;

impl Redact for PublicApiValue {
    fn write_redacted(&self, writer: &mut RedactionWriter<'_>) {
        writer.literal("PublicApiValue");
    }
}