modular-bitfield-impl 0.11.2

Bitfields for structs that allow for modular use of enums.
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

use super::{
    field_config::FieldConfig,
    BitfieldStruct,
    Config,
};

/// Compactly stores all shared and useful information about a single `#[bitfield]` field.
pub struct FieldInfo<'a> {
    /// The index of the field.
    pub index: usize,
    /// The actual field.
    pub field: &'a syn::Field,
    /// The configuration of the field.
    pub config: FieldConfig,
}

impl<'a> FieldInfo<'a> {
    /// Creates a new field info.
    pub fn new(id: usize, field: &'a syn::Field, config: FieldConfig) -> Self {
        Self {
            index: id,
            field,
            config,
        }
    }

    /// Returns the ident fragment for this field.
    pub fn ident_frag(&self) -> &dyn quote::IdentFragment {
        match &self.field.ident {
            Some(ident) => ident,
            None => &self.index,
        }
    }

    /// Returns the field's identifier as `String`.
    pub fn name(&self) -> String {
        Self::ident_as_string(self.field, self.index)
    }

    /// Returns the field's identifier at the given index as `String`.
    pub fn ident_as_string(field: &'a syn::Field, index: usize) -> String {
        field
            .ident
            .as_ref()
            .map(ToString::to_string)
            .unwrap_or_else(|| format!("{}", index))
    }
}

impl BitfieldStruct {
    /// Returns an iterator over the names of the fields.
    ///
    /// If a field has no name it is replaced by its field number.
    pub fn fields(
        item_struct: &syn::ItemStruct,
    ) -> impl Iterator<Item = (usize, &syn::Field)> {
        item_struct
            .fields
            .iter()
            .enumerate()
            .map(|(n, field)| (n, field))
    }

    /// Returns an iterator over the names of the fields.
    ///
    /// If a field has no name it is replaced by its field number.
    pub fn field_infos<'a, 'b: 'a>(
        &'a self,
        config: &'b Config,
    ) -> impl Iterator<Item = FieldInfo<'a>> {
        Self::fields(&self.item_struct).map(move |(n, field)| {
            let field_config = config
                .field_configs
                .get(&n)
                .map(|config| &config.value)
                .cloned()
                .unwrap_or_default();
            FieldInfo::new(n, field, field_config)
        })
    }
}