bitfields-impl 2.0.6

Macro for generating flexible bitfields. Useful for low-level code (embedded or emulators).
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

use std::str::FromStr;

/// The conversion endianness of data coming to or from the bitfield.
#[derive(Clone, Copy, PartialEq, Debug, Eq)]
pub enum ConversionEndian {
    /// Little endian conversion.
    Little,

    /// Big endian conversion.
    Big,
}

impl FromStr for ConversionEndian {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.trim().to_ascii_lowercase().as_str() {
            "little" => Ok(Self::Little),
            "big" => Ok(Self::Big),
            _ => Err(format!("Invalid endian argument '{s}'. Valid values are 'little' or 'big'.")),
        }
    }
}

/// Returns `Little` if `little` is set, `Big` if `big` is set, or `default`
/// otherwise.
pub const fn resolve_endian_feature(
    little: bool,
    big: bool,
    default: ConversionEndian,
) -> ConversionEndian {
    if little && big {
        default
    } else if little {
        ConversionEndian::Little
    } else if big {
        ConversionEndian::Big
    } else {
        default
    }
}