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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Generic URI redaction operations.

use super::Redactor;
use crate::RedactionInspection;
use crate::RedactionInspectionError;
use crate::RedactionTextOutput;

impl Redactor {
    /// Redacts a URI through one completed text transaction.
    ///
    /// # Parameters
    ///
    /// - `input`: Raw URI admitted before parsing and component classification.
    ///
    /// # Returns
    ///
    /// Final redacted text and its completion, reasons, and resource
    /// accounting.
    #[must_use]
    #[inline]
    pub fn redact_uri(&self, input: &str) -> RedactionTextOutput {
        let mut session = self.text_runtime();
        session.uri(|uri| {
            let _ = uri.value(input);
        });
        session.finish()
    }

    /// Inspects one URI without rendering it.
    ///
    /// # Errors
    ///
    /// Returns [`RedactionInspectionError`] when URI parsing fails or a
    /// shared resource limit prevents complete inspection.
    ///
    /// # Parameters
    ///
    /// - `input`: Raw URI to classify without rendering its components.
    ///
    /// # Returns
    ///
    /// A conclusive sensitivity inspection, or a value-free error retaining
    /// usage and reasons.
    #[inline]
    pub fn inspect_uri(&self, input: &str) -> Result<RedactionInspection, RedactionInspectionError> {
        let mut session = self.inspection_runtime();
        crate::formats::uri::inspection::inspect_uri(&mut session, input);
        session.finish()
    }
}