qubit-redact-derive 0.8.1

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
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Parsed state for one enum variant.

use syn::Variant;

use super::FieldsData;
use crate::attributes::SerdeVariantAttributes;

/// One enum variant with its declaration index and validated fields.
///
/// # Type Parameters
///
/// * `'a` - Lifetime of the borrowed variant and field syntax.
#[must_use]
pub(crate) struct VariantData<'a> {
    /// Original variant syntax node used for names and spans.
    variant: &'a Variant,
    /// Stable zero-based declaration index used by serialization.
    index: u32,
    /// Validated variant field shape.
    fields: FieldsData<'a>,
    /// Validated serialization-only variant controls.
    serde_attributes: SerdeVariantAttributes,
}

impl<'a> VariantData<'a> {
    /// Creates parsed state for one enum variant.
    ///
    /// # Parameters
    ///
    /// * `variant` - Original variant syntax node.
    /// * `index` - Stable zero-based declaration index.
    /// * `fields` - Validated variant field shape.
    /// * `serde_attributes` - Validated serialization-only variant controls.
    ///
    /// # Returns
    ///
    /// Parsed variant data retaining source order and spans.
    #[inline(always)]
    pub(crate) const fn new(
        variant: &'a Variant,
        index: u32,
        fields: FieldsData<'a>,
        serde_attributes: SerdeVariantAttributes,
    ) -> Self {
        Self {
            variant,
            index,
            fields,
            serde_attributes,
        }
    }

    /// Returns the original variant syntax node.
    ///
    /// # Returns
    ///
    /// The variant carrying its identifier and source span.
    #[inline(always)]
    pub(crate) const fn variant(&self) -> &'a Variant {
        self.variant
    }

    /// Returns the stable declaration index.
    ///
    /// # Returns
    ///
    /// The zero-based index used by serializer variant APIs.
    #[must_use]
    #[inline(always)]
    pub(crate) const fn index(&self) -> u32 {
        self.index
    }

    /// Returns the validated variant fields.
    ///
    /// # Returns
    ///
    /// Named, unnamed, or unit fields in source order.
    #[inline(always)]
    pub(crate) const fn fields(&self) -> &FieldsData<'a> {
        &self.fields
    }

    /// Returns the validated serialization-only variant controls.
    ///
    /// # Returns
    ///
    /// Variant naming, field renaming, and skip state.
    #[inline(always)]
    pub(crate) const fn serde_attributes(&self) -> &SerdeVariantAttributes {
        &self.serde_attributes
    }
}