numbered/number.rs
1//! Number accessors live on [`Number`], not as inherent methods on the enum.
2
3macro_rules! as_number_alias {
4 ($($method:ident : $ty:ty),+ $(,)?) => {
5 $(
6 /// Alias of [`number`](Self::number) when [`Repr`](Self::Repr)
7 #[doc = concat!(" is `", stringify!($ty), "`.")]
8 #[inline]
9 #[must_use]
10 fn $method(&self) -> $ty
11 where
12 Self: Number<Repr = $ty>,
13 {
14 self.number()
15 }
16 )+
17 };
18}
19
20macro_rules! from_number_alias {
21 ($($method:ident : $ty:ty),+ $(,)?) => {
22 $(
23 /// Alias of [`from_number`](Self::from_number) when
24 #[doc = concat!("[`Repr`](Self::Repr) is `", stringify!($ty), "`.")]
25 #[inline]
26 fn $method(n: $ty) -> Result<Self, crate::FromNumberError<$ty>>
27 where
28 Self: FromNumber<Repr = $ty>,
29 {
30 Self::from_number(n)
31 }
32 )+
33 };
34}
35
36/// Stable integer number for a numbered enum.
37///
38/// Import this trait to call `e.number()` / `e.as_u8()`. A user inherent
39/// `fn number` still compiles; use `<E as Number>::number(&e)`.
40///
41/// Not `const`: trait methods cannot be. In const context, use
42/// [`crate::Variants::NUMBERS`].
43///
44/// [`PartialEq`](core::cmp::PartialEq) on the enum (generated) compares
45/// this number.
46pub trait Number {
47 /// Integer type chosen in `#[numbered(<repr>)]`.
48 type Repr: Copy;
49
50 /// Stable integer number assigned to this variant.
51 ///
52 /// Overridden by `#[numbered(n = ...)]` or a native discriminant.
53 /// Takes `&self` so variants with a payload do not need `Copy`.
54 #[must_use]
55 fn number(&self) -> Self::Repr;
56
57 as_number_alias! {
58 as_u8: u8,
59 as_u16: u16,
60 as_u32: u32,
61 as_u64: u64,
62 as_usize: usize,
63 as_i8: i8,
64 as_i16: i16,
65 as_i32: i32,
66 as_i64: i64,
67 as_isize: isize,
68 }
69}
70
71/// Parse a number into `Self`.
72///
73/// Implemented only for fieldless enums: a number cannot rebuild a payload.
74/// Not `const`: trait methods cannot be. In const context, use
75/// [`crate::Variants::NUMBERS`].
76pub trait FromNumber: Sized {
77 /// Integer type chosen in `#[numbered(<repr>)]`.
78 type Repr: Copy;
79
80 /// Parse a number into `Self`.
81 ///
82 /// Equivalent to [`TryFrom::try_from`](core::convert::TryFrom).
83 fn from_number(n: Self::Repr) -> Result<Self, crate::FromNumberError<Self::Repr>>;
84
85 from_number_alias! {
86 from_u8: u8,
87 from_u16: u16,
88 from_u32: u32,
89 from_u64: u64,
90 from_usize: usize,
91 from_i8: i8,
92 from_i16: i16,
93 from_i32: i32,
94 from_i64: i64,
95 from_isize: isize,
96 }
97}