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
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
114
115
116
117
118
119
120
121
122
123
124

// devela::num::grain::prim
//
//! Marker traits for primitives.
//
// TOC
// - (trait Sealed)
// - trait Prim
// - trait PrimFitPtr
// - trait PrimIndex

#![expect(private_bounds, reason = "Sealed traits")]

use crate::{NonMaxU8, NonMaxU16, NonMaxU32, NonMaxU64, NonMaxUsize, items};
#[cfg(doc)]
use crate::{PrimCast, PrimFloat, PrimInt, PrimJoin, PrimScalar, PrimSint, PrimSplit, PrimUint};

macro_rules! _impl_prim {
    ($trait:ident for $($P:ty),+ $(,)?) => { $( _impl_prim![% $trait for $P]; )+ };
    (%$trait:ident for $P:ty) => { impl $trait for $P {} };
}

/// Marker trait to prevent downstream implementations of the `Prim*` traits.
trait Sealed {}
_impl_prim![Sealed for
    (), bool, char,
    u8, u16, u32, u64, u128, usize,
    i8, i16, i32, i64, i128, isize,
    f32, f64,
    NonMaxU8, NonMaxU16, NonMaxU32, NonMaxU64, NonMaxUsize,
];

/* primitives */

#[doc = crate::_tags!(code primitive)]
/// Language primitive value types.
#[doc = crate::_doc_meta!{location("code/marker")}]
///
/// See also the related traits:
/// - markers: [`PrimFitPtr`], [`PrimIndex`],
/// - casting: [`PrimCast`], [`PrimJoin`], [`PrimSplit`],
/// - numeric: [`PrimScalar`], [`PrimFloat`], [`PrimInt`], [`PrimSint`], [`PrimUint`].
///
#[doc(alias = "Primitive")]
pub trait Prim: Sealed + Copy + 'static {}
_impl_prim![Prim for
    (), bool, char,
    u8, u16, u32, u64, u128, usize,
    i8, i16, i32, i64, i128, isize,
    f32, f64,
];

/* pointer-width related */

#[doc = crate::_tags!(code mem primitive)]
/// Primitive value types that fit in pointer-width on supported Rust targets.
#[doc = crate::_doc_meta!{location("code/marker")}]
#[doc(alias = "PrimitiveFitPtr")]
pub trait PrimFitPtr: Prim {}

_impl_prim![PrimFitPtr for (), bool, u8, i8, usize, isize];
#[cfg(target_pointer_width = "16")]
_impl_prim![PrimFitPtr for bool, u16, i16];
#[cfg(target_pointer_width = "32")]
_impl_prim![PrimFitPtr for u16, u32, i16, i32, f32];
#[cfg(target_pointer_width = "64")]
_impl_prim![PrimFitPtr for u16, u32, u64, i16, i32, i64, f32, f64];

#[doc = crate::_tags!(code mem num primitive)]
/// Primitive types that can be used for indexing.
#[doc = crate::_doc_meta!{location("code/marker")}]
#[doc(alias = "PrimitiveIndex")]
pub trait PrimIndex: crate::PrimUint + PrimFitPtr {}

_impl_prim![PrimIndex for u8, usize];
#[cfg(target_pointer_width = "16")]
_impl_prim![PrimIndex for u16];
#[cfg(target_pointer_width = "32")]
_impl_prim![PrimIndex for u16, u32];
#[cfg(target_pointer_width = "64")]
_impl_prim![PrimIndex for u16, u32, u64];

#[doc = crate::_tags!(code mem num primitive niche)]
/// A representation accepted for compact contiguous indexing.
#[doc = crate::_doc_meta!{location("code/marker")}]
///
/// This trait marks types whose value domain is suitable for representing
/// non-negative indices, including primitive index integers and selected
/// niche-backed wrappers such as `NonMaxU*`.
///
/// Unlike [`PrimIndex`], this trait may be implemented for wrapper types.
/// Its [`Prim`][Self::Prim] associated type names the primitive integer carrier.
#[doc(alias = "IndexRepresentation")]
#[doc(alias = "PrimitiveIndexRepresentation")]
pub trait IndexRepr: Copy {
    /// The primitive integer backing this index representation.
    type Prim: PrimIndex;
}
items! {
    impl IndexRepr for u8 { type Prim = u8; }
    impl IndexRepr for usize { type Prim = u8; }
    impl IndexRepr for NonMaxU8 { type Prim = u8; }
    impl IndexRepr for NonMaxUsize { type Prim = usize; }
    #[cfg(target_pointer_width = "16")]
    items! {
        impl IndexRepr for u16 { type Prim = u16; }
        impl IndexRepr for NonMaxU16 { type Prim = u16; }
    }
    #[cfg(target_pointer_width = "32")]
    items! {
        impl IndexRepr for u16 { type Prim = u16; }
        impl IndexRepr for u32 { type Prim = u32; }
        impl IndexRepr for NonMaxU16 { type Prim = u16; }
        impl IndexRepr for NonMaxU32 { type Prim = u32; }
    }
    #[cfg(target_pointer_width = "64")]
    items! {
        impl IndexRepr for u16 { type Prim = u16; }
        impl IndexRepr for u32 { type Prim = u32; }
        impl IndexRepr for u64 { type Prim = u64; }
        impl IndexRepr for NonMaxU16 { type Prim = u16; }
        impl IndexRepr for NonMaxU32 { type Prim = u32; }
        impl IndexRepr for NonMaxU64 { type Prim = u64; }
    }
}