qubit-redact-derive 0.5.0

Derive macros for qubit-redact domain-object formatting
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Unique formatting mode selected for one derived field.

use syn::Ident;

use super::Sensitivity;
/// Formatting behavior generated for one named field.
#[must_use]
pub(crate) enum FieldMode {
    /// Formats the original field with its ordinary `Debug` implementation.
    Unmarked,
    /// Masks a supported textual value at an explicit sensitivity level.
    Level(Sensitivity),
    /// Omits the field name and value without imposing formatting bounds.
    Skip,
    /// Recursively formats the field through its `Redact` implementation.
    Nested,
    /// Classifies string map values by their runtime keys and active policy.
    Map,
    /// Masks map keys and, optionally, map values at fixed levels.
    MapLevels {
        /// Sensitivity applied to every map key.
        key: Option<Sensitivity>,
        /// Sensitivity applied to every map value.
        value: Option<Sensitivity>,
    },
    /// Classifies a field value by a sibling text key and active policy.
    KeyedBy(Ident),
    /// Redacts JSON text stored in a string field.
    Json,
}