devela 0.28.0

A development substrate of coherence.
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

// devela::data::value::word
//
//! Defines [`Word`], [`word!`].
//

#[doc = crate::_tags!(data word)]
/// A fixed-width copyable item with an explicit raw representation.
#[doc = crate::_doc_meta!{location("data")}]
///
/// It is also implemented with [`word!`].
pub trait Word: Copy + Eq {
    /// The physical representation type.
    type Repr: Copy + Eq;

    /// Returns the raw representation.
    fn raw(self) -> Self::Repr;

    /// Creates the word from its raw representation.
    fn from_raw(raw: Self::Repr) -> Self;
}

#[doc = crate::_tags!(data word construction)]
/// Defines a transparent word type over a raw representation.
#[doc = crate::_doc_meta!{location("data")}]
///
/// Implements both the [`Word`] trait and its methods directly as const-fns.
#[macro_export]
#[cfg_attr(cargo_primary_package, doc(hidden))]
macro_rules! word {
    (
        $(#[$meta:meta])*
        $vis:vis struct $name:ident($repr:ty);
    ) => {
        $(#[$meta])*
        #[repr(transparent)]
        #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
        $vis struct $name($repr);

        impl $name {
            /// Creates the word from its raw representation.
            #[must_use] #[inline(always)]
            pub const fn from_raw(raw: $repr) -> Self { Self(raw) }
            /// Returns the raw representation.
            #[must_use] #[inline(always)]
            pub const fn raw(self) -> $repr { self.0 }
        }
        impl $crate::Word for $name {
            type Repr = $repr;
            #[inline(always)]
            fn raw(self) -> Self::Repr { self.raw() }
            #[inline(always)]
            fn from_raw(raw: Self::Repr) -> Self { Self::from_raw(raw) }
        }
    };
}
pub use word;