qubit-redact 0.3.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! One argument and the sensitivity known by its caller.

use std::{
    ffi::OsStr,
    fmt,
};

use crate::Sensitivity;

/// A borrowed argument with optional authoritative sensitivity metadata.
///
/// Plain items may be inspected by
/// [`super::ArgvRedactor::redact_heuristically`]. Sensitive items are always
/// masked at their explicit level and never interpreted as command-line syntax.
///
/// # Type Parameters
///
/// * `'a` - Lifetime of the borrowed operating-system argument.
#[must_use = "pass the item to an argv redactor"]
#[derive(Clone, Copy)]
pub struct ArgvItem<'a> {
    /// Original operating-system argument value.
    value: &'a OsStr,
    /// Authoritative sensitivity supplied by the caller, when known.
    sensitivity: Option<Sensitivity>,
}

impl fmt::Debug for ArgvItem<'_> {
    /// Formats safe argument metadata without exposing the original value.
    ///
    /// # Parameters
    ///
    /// * `formatter` - Destination formatting context.
    ///
    /// # Returns
    ///
    /// The formatter result from writing the safe metadata.
    ///
    /// # Errors
    ///
    /// Returns [`fmt::Error`] when the destination rejects a write.
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("ArgvItem")
            .field("value", &"<redacted>")
            .field("value_len", &self.value.as_encoded_bytes().len())
            .field("sensitivity", &self.sensitivity)
            .finish()
    }
}

impl<'a> ArgvItem<'a> {
    /// Creates an item with no caller-supplied sensitivity.
    ///
    /// # Parameters
    ///
    /// * `value` - Argument value that may be inspected by heuristic mode.
    ///
    /// # Returns
    ///
    /// A plain borrowed argument item.
    #[inline(always)]
    pub const fn plain(value: &'a OsStr) -> Self {
        Self {
            value,
            sensitivity: None,
        }
    }

    /// Creates an item whose value must be masked at `sensitivity`.
    ///
    /// # Parameters
    ///
    /// * `value` - Argument value to mask.
    /// * `sensitivity` - Authoritative masking level for the complete value.
    ///
    /// # Returns
    ///
    /// A sensitive borrowed argument item.
    #[inline(always)]
    pub const fn sensitive(value: &'a OsStr, sensitivity: Sensitivity) -> Self {
        Self {
            value,
            sensitivity: Some(sensitivity),
        }
    }

    /// Returns the original operating-system argument.
    ///
    /// # Returns
    ///
    /// The borrowed argument value.
    #[inline(always)]
    pub(super) const fn value(&self) -> &'a OsStr {
        self.value
    }

    /// Returns the caller-supplied sensitivity, when present.
    ///
    /// # Returns
    ///
    /// `Some(level)` for an explicitly sensitive item, or `None` for a plain
    /// item.
    #[inline(always)]
    pub(super) const fn sensitivity(&self) -> Option<Sensitivity> {
        self.sensitivity
    }
}