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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

#![doc = include_str!("../docs.md")]
#![cfg_attr(not(test), no_std)]
#![cfg_attr(feature = "nightly", feature(const_trait_impl))]
#![cfg_attr(all(doc, feature = "nightly"), feature(doc_cfg))]
#![cfg_attr(all(any(doc, test), feature = "nightly"), feature(trivial_bounds))]
#![warn(clippy::all)]
#![cfg_attr(
    all(any(doc, test), feature = "gce"),
    feature(generic_const_exprs),
    expect(incomplete_features)
)]

#[cfg(not(feature = "nightly"))]
macro_rules! const_trait {
    ($trait: item) => {
        $trait
    };
}

#[cfg(feature = "nightly")]
macro_rules! const_trait {
    (
        $(#[$attr:meta])*
        $vis:vis trait $($tokens:tt)*
    ) => {
        $(#[$attr])*
        $vis const trait $($tokens)*
    };
}

#[doc(hidden)]
pub mod __private {
    pub use static_assertions;

    #[inline(always)]
    pub const fn min(a: usize, b: usize) -> usize {
        if a < b {
            a
        } else {
            b
        }
    }

    #[inline(always)]
    pub const fn max(a: usize, b: usize) -> usize {
        if a > b {
            a
        } else {
            b
        }
    }

    #[cfg(feature = "gce")]
    const_trait! {
        pub trait NestedBitfield<'a, S> {
            fn __from_storage(storage: &'a S) -> Self;
        }
    }

    #[cfg(feature = "gce")]
    const_trait! {
        pub trait NestedMutBitfield<'a, S> {
            fn __from_storage(storage: &'a mut S) -> Self;
        }
    }

    #[cfg(feature = "gce")]
    const_trait! {
        pub trait NestedWriteBitfield<'a, S> {
            fn __from_storage(storage: &'a mut S) -> Self;
        }
    }
}

/// The main focus of the crate. Defines a bitfield struct.
#[doc = include_str!("../usage_examples/bitfield.md")]
pub use macros::bitfield;

/// Reads a single field from an anonymous bitfield, without creating a bitfield struct.
#[doc = include_str!("../usage_examples/bits.md")]
pub use macros::bits;

/// Returns an anonymous bitfield with a single field modified, without creating a bitfield struct.
#[doc = include_str!("../usage_examples/with_bits.md")]
pub use macros::with_bits;

/// Modifies a single field in an anonymous bitfield, without creating a bitfield struct.
#[doc = include_str!("../usage_examples/set_bits.md")]
pub use macros::set_bits;

/// A derive macro to implement any applicable conversion traits between an enum and the builtin
/// integer and boolean types corresponding to variant discriminants.
#[doc = include_str!("../usage_examples/conv_raw.md")]
pub use macros::ConvRaw;

#[cfg(feature = "nightly")]
#[cfg_attr(all(doc, feature = "nightly"), doc(cfg(feature = "nightly")))]
/// A derive macro to implement `Bits<T> for U` and the related traits for a type `T` and all
/// integer bitfield storage types `U`, by unwrapping the conversion results.
#[doc = include_str!("../usage_examples/unwrap_bits.md")]
pub use macros::UnwrapBits;

mod conv;
pub use conv::*;
mod traits;
pub use traits::*;

#[cfg(any(test, doc))]
extern crate self as proc_bitfield;

#[cfg(doc)]
/// Sample bitfields to showcase the crate's features
pub mod example;