superbitty 0.3.2

A bitfields crate.
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

/// A raw representation of a bitfield with base type `T`. This
/// is used for storing the bitfields data.
///
/// You can get the `T` via the [`raw()`] method.
///
/// [`raw()`]: Raw::raw
pub struct Raw<T: OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields>(T);

impl<T: OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields> Clone for Raw<T> {
    fn clone(&self) -> Self {
        *self
    }
}
impl<T: OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields> Copy for Raw<T> {}

impl<T: OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields> Raw<T> {
    /// # Safety
    ///
    /// For anyone that is not the `bitfields!` macro, this is always undefined behavior
    /// to call.
    ///
    /// For it, this should uphold the invariant of the bitfields struct that it always
    /// contains valid instances.
    #[doc(hidden)]
    pub const unsafe fn new(v: T) -> Self {
        Self(v)
    }

    /// The raw value of this bitfields.
    pub fn raw(self) -> T {
        self.0
    }

    /// # Safety
    ///
    /// For anyone that is not the `bitfields!` macro, this is always undefined behavior
    /// to call.
    ///
    /// For it, this should uphold the invariant of the bitfields struct that it always
    /// contains valid instances.
    #[doc(hidden)]
    pub unsafe fn get_mut(&mut self) -> &mut T {
        &mut self.0
    }
}

// This trait should not be exposed, it is sealed.
pub trait OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields: Copy {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for u8 {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for u16 {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for u32 {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for u64 {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for u128 {}
impl OnlyPrimitiveUnsignedIntegersAreAllowedAsBaseTypesForSuperbittyBitfields for usize {}