Skip to main content

core/
pat.rs

1//! Helper module for exporting the `pattern_type` macro
2
3use crate::marker::{Freeze, PointeeSized, Unsize};
4use crate::ops::{CoerceUnsized, DispatchFromDyn};
5
6/// Creates a pattern type.
7/// ```ignore (cannot test this from within core yet)
8/// type Positive = std::pat::pattern_type!(i32 is 1..);
9/// ```
10#[allow_internal_unstable(internal_syntax)]
11#[unstable(feature = "pattern_types", issue = "123646")]
12#[diagnostic::opaque]
13pub macro pattern_type($( $arg:tt )*) {
14    k#pattern_type($( $arg )*)
15}
16
17/// A trait implemented for integer types and `char`.
18/// Useful in the future for generic pattern types, but
19/// used right now to simplify ast lowering of pattern type ranges.
20#[unstable(feature = "pattern_type_range_trait", issue = "123646")]
21#[rustc_const_unstable(feature = "pattern_type_range_trait", issue = "123646")]
22#[diagnostic::on_unimplemented(
23    message = "`{Self}` is not a valid base type for range patterns",
24    label = "only integer types and `char` are supported"
25)]
26pub const trait RangePattern {
27    /// Trait version of the inherent `MIN` assoc const.
28    #[lang = "RangeMin"]
29    const MIN: Self;
30
31    /// Trait version of the inherent `MIN` assoc const.
32    #[lang = "RangeMax"]
33    const MAX: Self;
34
35    /// A compile-time helper to subtract 1 for exclusive ranges.
36    #[lang = "RangeSub"]
37    #[track_caller]
38    fn sub_one(self) -> Self;
39}
40
41macro_rules! impl_range_pat {
42    ($($ty:ty,)*) => {
43        $(
44            #[rustc_const_unstable(feature = "pattern_type_range_trait", issue = "123646")]
45            const impl RangePattern for $ty {
46                const MIN: $ty = <$ty>::MIN;
47                const MAX: $ty = <$ty>::MAX;
48                fn sub_one(self) -> Self {
49                    match self.checked_sub(1) {
50                        Some(val) => val,
51                        None => panic!("exclusive range end at minimum value of type")
52                    }
53                }
54            }
55        )*
56    }
57}
58
59impl_range_pat! {
60    i8, i16, i32, i64, i128, isize,
61    u8, u16, u32, u64, u128, usize,
62}
63
64#[rustc_const_unstable(feature = "pattern_type_range_trait", issue = "123646")]
65const impl RangePattern for char {
66    const MIN: Self = char::MIN;
67
68    const MAX: Self = char::MAX;
69
70    fn sub_one(self) -> Self {
71        match char::from_u32(self as u32 - 1) {
72            None => panic!("exclusive range to start of valid chars"),
73            Some(val) => val,
74        }
75    }
76}
77
78impl<T: PointeeSized, U: PointeeSized> CoerceUnsized<pattern_type!(*const U is !null)> for pattern_type!(*const T is !null) where
79    T: Unsize<U>
80{
81}
82
83impl<T: DispatchFromDyn<U>, U> DispatchFromDyn<pattern_type!(U is !null)> for pattern_type!(T is !null) {}
84
85impl<T: PointeeSized> Unpin for pattern_type!(*const T is !null) {}
86
87unsafe impl<T: PointeeSized> Freeze for pattern_type!(*const T is !null) {}
88
89unsafe impl<T: PointeeSized> Freeze for pattern_type!(*mut T is !null) {}