proc-bitfield 0.5.3

A crate to expressively declare bitfield-like structs
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

mod arr_impls;
mod int_impls;

/// Trait implemented by all bitfields generated by the crate in order to know their storage type.
pub trait Bitfield {
    /// This bitfield's storage type.
    type Storage;
}

#[cfg(feature = "gce")]
const_trait! {
    /// Marker trait for bitfields that can be used as read-only nested bitfields.
    #[cfg_attr(all(doc, feature = "nightly"), doc(cfg(feature = "gce")))]
    pub trait NestableBitfield<S, const START: usize, const END: usize> {
        type Nested<'a>: const crate::__private::NestedBitfield<'a, S>
        where
            S: 'a;
    }
}

#[cfg(feature = "gce")]
const_trait! {
    /// Marker trait for bitfields that can be used as readable and writable nested bitfields.
    #[cfg_attr(all(doc, feature = "nightly"), doc(cfg(feature = "gce")))]
    pub trait NestableMutBitfield<S, const START: usize, const END: usize> {
        type NestedMut<'a>: const crate::__private::NestedMutBitfield<'a, S>
        where
            S: 'a;
    }
}

#[cfg(feature = "gce")]
const_trait! {
    /// Marker trait for bitfields that can be used as write-only nested bitfields.
    #[cfg_attr(all(doc, feature = "nightly"), doc(cfg(feature = "gce")))]
    pub trait NestableWriteBitfield<S, const START: usize, const END: usize> {
        type NestedWrite<'a>: const crate::__private::NestedWriteBitfield<'a, S>
        where
            S: 'a;
    }
}

const_trait! {
    /// Read a range of bits inside a value.
    pub trait Bits<T> {
        /// Read `self`'s `START..END` bit range (with `END` excluded) as a value of type `T`.
        fn bits<const START: usize, const END: usize>(&self) -> T;
    }
}

const_trait! {
    /// Return a value with a range of bits modified.
    pub trait WithBits<T> {
        #[must_use]
        /// Returns `self` with the the `START..END` bit range (with `END` excluded) set to the given
        /// value of type `T`.
        fn with_bits<const START: usize, const END: usize>(self, value: T) -> Self;
    }
}

const_trait! {
    /// Modify a range of bits inside a value in place.
    pub trait SetBits<T> {
        /// Sets `self`'s `START..END` bit range (with `END` excluded) to the given value of type `T`
        /// in place.
        fn set_bits<const START: usize, const END: usize>(&mut self, value: T);
    }
}

const_trait! {
    /// Read a single bit inside a value.
    pub trait Bit {
        /// Read `self`'s specified bit.
        fn bit<const BIT: usize>(&self) -> bool;
    }
}

const_trait! {
    /// Return a value with a single bit modified.
    pub trait WithBit {
        /// Returns `self` with the the specified bit set to 1 if `value` is `true`, and 0
        /// otherwise.
        #[must_use]
        fn with_bit<const BIT: usize>(self, value: bool) -> Self;
    }
}

const_trait! {
    /// Modify a single bit inside a value in place.
    pub trait SetBit {
        /// Sets `self`'s specified bit to 1 if `value` is `true`, and 0 otherwise.
        fn set_bit<const BIT: usize>(&mut self, value: bool);
    }
}