core/convert/
num.rs

1use crate::num::TryFromIntError;
2
3#[cfg(not(feature = "ferrocene_subset"))]
4mod private {
5    /// This trait being unreachable from outside the crate
6    /// prevents other implementations of the `FloatToInt` trait,
7    /// which allows potentially adding more trait methods after the trait is `#[stable]`.
8    #[unstable(feature = "convert_float_to_int", issue = "67057")]
9    pub trait Sealed {}
10}
11
12/// Supporting trait for inherent methods of `f32` and `f64` such as `to_int_unchecked`.
13/// Typically doesn’t need to be used directly.
14#[cfg(not(feature = "ferrocene_subset"))]
15#[unstable(feature = "convert_float_to_int", issue = "67057")]
16pub trait FloatToInt<Int>: private::Sealed + Sized {
17    #[unstable(feature = "convert_float_to_int", issue = "67057")]
18    #[doc(hidden)]
19    unsafe fn to_int_unchecked(self) -> Int;
20}
21
22#[cfg(not(feature = "ferrocene_subset"))]
23macro_rules! impl_float_to_int {
24    ($Float:ty => $($Int:ty),+) => {
25        #[unstable(feature = "convert_float_to_int", issue = "67057")]
26        impl private::Sealed for $Float {}
27        $(
28            #[unstable(feature = "convert_float_to_int", issue = "67057")]
29            impl FloatToInt<$Int> for $Float {
30                #[inline]
31                unsafe fn to_int_unchecked(self) -> $Int {
32                    // SAFETY: the safety contract must be upheld by the caller.
33                    unsafe { crate::intrinsics::float_to_int_unchecked(self) }
34                }
35            }
36        )+
37    }
38}
39
40#[cfg(not(feature = "ferrocene_subset"))]
41impl_float_to_int!(f16 => u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);
42#[cfg(not(feature = "ferrocene_subset"))]
43impl_float_to_int!(f32 => u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);
44#[cfg(not(feature = "ferrocene_subset"))]
45impl_float_to_int!(f64 => u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);
46#[cfg(not(feature = "ferrocene_subset"))]
47impl_float_to_int!(f128 => u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize);
48
49// Conversion traits for primitive integer and float types
50// Conversions T -> T are covered by a blanket impl and therefore excluded
51// Some conversions from and to usize/isize are not implemented due to portability concerns
52macro_rules! impl_from {
53    (bool => $Int:ty $(,)?) => {
54        impl_from!(
55            bool => $Int,
56            #[stable(feature = "from_bool", since = "1.28.0")],
57            concat!(
58                "Converts a [`bool`] to [`", stringify!($Int), "`] losslessly.\n",
59                "The resulting value is `0` for `false` and `1` for `true` values.\n",
60                "\n",
61                "# Examples\n",
62                "\n",
63                "```\n",
64                "assert_eq!(", stringify!($Int), "::from(true), 1);\n",
65                "assert_eq!(", stringify!($Int), "::from(false), 0);\n",
66                "```\n",
67            ),
68        );
69    };
70    ($Small:ty => $Large:ty, #[$attr:meta] $(,)?) => {
71        impl_from!(
72            $Small => $Large,
73            #[$attr],
74            concat!("Converts [`", stringify!($Small), "`] to [`", stringify!($Large), "`] losslessly."),
75        );
76    };
77    ($Small:ty => $Large:ty, #[$attr:meta], $doc:expr $(,)?) => {
78        #[$attr]
79        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
80        impl const From<$Small> for $Large {
81            // Rustdocs on the impl block show a "[+] show undocumented items" toggle.
82            // Rustdocs on functions do not.
83            #[doc = $doc]
84            #[inline(always)]
85            fn from(small: $Small) -> Self {
86                small as Self
87            }
88        }
89    };
90}
91
92// boolean -> integer
93impl_from!(bool => u8);
94impl_from!(bool => u16);
95impl_from!(bool => u32);
96impl_from!(bool => u64);
97impl_from!(bool => u128);
98impl_from!(bool => usize);
99impl_from!(bool => i8);
100impl_from!(bool => i16);
101impl_from!(bool => i32);
102impl_from!(bool => i64);
103impl_from!(bool => i128);
104impl_from!(bool => isize);
105
106// unsigned integer -> unsigned integer
107impl_from!(u8 => u16, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
108impl_from!(u8 => u32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
109impl_from!(u8 => u64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
110impl_from!(u8 => u128, #[stable(feature = "i128", since = "1.26.0")]);
111impl_from!(u8 => usize, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
112impl_from!(u16 => u32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
113impl_from!(u16 => u64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
114impl_from!(u16 => u128, #[stable(feature = "i128", since = "1.26.0")]);
115impl_from!(u32 => u64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
116impl_from!(u32 => u128, #[stable(feature = "i128", since = "1.26.0")]);
117impl_from!(u64 => u128, #[stable(feature = "i128", since = "1.26.0")]);
118
119// signed integer -> signed integer
120impl_from!(i8 => i16, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
121impl_from!(i8 => i32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
122impl_from!(i8 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
123impl_from!(i8 => i128, #[stable(feature = "i128", since = "1.26.0")]);
124impl_from!(i8 => isize, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
125impl_from!(i16 => i32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
126impl_from!(i16 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
127impl_from!(i16 => i128, #[stable(feature = "i128", since = "1.26.0")]);
128impl_from!(i32 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
129impl_from!(i32 => i128, #[stable(feature = "i128", since = "1.26.0")]);
130impl_from!(i64 => i128, #[stable(feature = "i128", since = "1.26.0")]);
131
132// unsigned integer -> signed integer
133#[cfg(not(feature = "ferrocene_subset"))]
134impl_from!(u8 => i16, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
135#[cfg(not(feature = "ferrocene_subset"))]
136impl_from!(u8 => i32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
137#[cfg(not(feature = "ferrocene_subset"))]
138impl_from!(u8 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
139#[cfg(not(feature = "ferrocene_subset"))]
140impl_from!(u8 => i128, #[stable(feature = "i128", since = "1.26.0")]);
141#[cfg(not(feature = "ferrocene_subset"))]
142impl_from!(u16 => i32, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
143#[cfg(not(feature = "ferrocene_subset"))]
144impl_from!(u16 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
145#[cfg(not(feature = "ferrocene_subset"))]
146impl_from!(u16 => i128, #[stable(feature = "i128", since = "1.26.0")]);
147#[cfg(not(feature = "ferrocene_subset"))]
148impl_from!(u32 => i64, #[stable(feature = "lossless_int_conv", since = "1.5.0")]);
149#[cfg(not(feature = "ferrocene_subset"))]
150impl_from!(u32 => i128, #[stable(feature = "i128", since = "1.26.0")]);
151#[cfg(not(feature = "ferrocene_subset"))]
152impl_from!(u64 => i128, #[stable(feature = "i128", since = "1.26.0")]);
153
154// The C99 standard defines bounds on INTPTR_MIN, INTPTR_MAX, and UINTPTR_MAX
155// which imply that pointer-sized integers must be at least 16 bits:
156// https://port70.net/~nsz/c/c99/n1256.html#7.18.2.4
157impl_from!(u16 => usize, #[stable(feature = "lossless_iusize_conv", since = "1.26.0")]);
158impl_from!(u8 => isize, #[stable(feature = "lossless_iusize_conv", since = "1.26.0")]);
159impl_from!(i16 => isize, #[stable(feature = "lossless_iusize_conv", since = "1.26.0")]);
160
161// RISC-V defines the possibility of a 128-bit address space (RV128).
162
163// CHERI proposes 128-bit “capabilities”. Unclear if this would be relevant to usize/isize.
164// https://www.cl.cam.ac.uk/research/security/ctsrd/pdfs/20171017a-cheri-poster.pdf
165// https://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-951.pdf
166
167// Note: integers can only be represented with full precision in a float if
168// they fit in the significand, which is:
169// * 11 bits in f16
170// * 24 bits in f32
171// * 53 bits in f64
172// * 113 bits in f128
173// Lossy float conversions are not implemented at this time.
174// FIXME(f16_f128): The `f16`/`f128` impls `#[stable]` attributes should be changed to reference
175// `f16`/`f128` when they are stabilised (trait impls have to have a `#[stable]` attribute, but none
176// of the `f16`/`f128` impls can be used on stable as the `f16` and `f128` types are unstable).
177
178// signed integer -> float
179#[cfg(not(feature = "ferrocene_subset"))]
180impl_from!(i8 => f16, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
181#[cfg(not(feature = "ferrocene_subset"))]
182impl_from!(i8 => f32, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
183#[cfg(not(feature = "ferrocene_subset"))]
184impl_from!(i8 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
185#[cfg(not(feature = "ferrocene_subset"))]
186impl_from!(i8 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
187#[cfg(not(feature = "ferrocene_subset"))]
188impl_from!(i16 => f32, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
189#[cfg(not(feature = "ferrocene_subset"))]
190impl_from!(i16 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
191#[cfg(not(feature = "ferrocene_subset"))]
192impl_from!(i16 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
193#[cfg(not(feature = "ferrocene_subset"))]
194impl_from!(i32 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
195#[cfg(not(feature = "ferrocene_subset"))]
196impl_from!(i32 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
197// FIXME(f16_f128): This impl would allow using `f128` on stable before it is stabilised.
198// impl_from!(i64 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
199
200// unsigned integer -> float
201#[cfg(not(feature = "ferrocene_subset"))]
202impl_from!(u8 => f16, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
203#[cfg(not(feature = "ferrocene_subset"))]
204impl_from!(u8 => f32, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
205#[cfg(not(feature = "ferrocene_subset"))]
206impl_from!(u8 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
207#[cfg(not(feature = "ferrocene_subset"))]
208impl_from!(u8 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
209#[cfg(not(feature = "ferrocene_subset"))]
210impl_from!(u16 => f32, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
211#[cfg(not(feature = "ferrocene_subset"))]
212impl_from!(u16 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
213#[cfg(not(feature = "ferrocene_subset"))]
214impl_from!(u16 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
215#[cfg(not(feature = "ferrocene_subset"))]
216impl_from!(u32 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
217#[cfg(not(feature = "ferrocene_subset"))]
218impl_from!(u32 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
219// FIXME(f16_f128): This impl would allow using `f128` on stable before it is stabilised.
220// impl_from!(u64 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
221
222// float -> float
223// FIXME(f16_f128): adding additional `From<{float}>` impls to `f32` breaks inference. See
224// <https://github.com/rust-lang/rust/issues/123831>
225#[cfg(not(feature = "ferrocene_subset"))]
226impl_from!(f16 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
227#[cfg(not(feature = "ferrocene_subset"))]
228impl_from!(f16 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
229#[cfg(not(feature = "ferrocene_subset"))]
230impl_from!(f32 => f64, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
231#[cfg(not(feature = "ferrocene_subset"))]
232impl_from!(f32 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
233#[cfg(not(feature = "ferrocene_subset"))]
234impl_from!(f64 => f128, #[stable(feature = "lossless_float_conv", since = "1.6.0")]);
235
236#[cfg(not(feature = "ferrocene_subset"))]
237macro_rules! impl_float_from_bool {
238    (
239        $float:ty $(;
240            doctest_prefix: $(#[doc = $doctest_prefix:literal])*
241            doctest_suffix: $(#[doc = $doctest_suffix:literal])*
242        )?
243    ) => {
244        #[stable(feature = "float_from_bool", since = "1.68.0")]
245        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
246            impl const From<bool> for $float {
247            #[doc = concat!("Converts a [`bool`] to [`", stringify!($float),"`] losslessly.")]
248            /// The resulting value is positive `0.0` for `false` and `1.0` for `true` values.
249            ///
250            /// # Examples
251            /// ```
252            $($(#[doc = $doctest_prefix])*)?
253            #[doc = concat!("let x: ", stringify!($float)," = false.into();")]
254            /// assert_eq!(x, 0.0);
255            /// assert!(x.is_sign_positive());
256            ///
257            #[doc = concat!("let y: ", stringify!($float)," = true.into();")]
258            /// assert_eq!(y, 1.0);
259            $($(#[doc = $doctest_suffix])*)?
260            /// ```
261            #[inline]
262            fn from(small: bool) -> Self {
263                small as u8 as Self
264            }
265        }
266    };
267}
268
269// boolean -> float
270#[cfg(not(feature = "ferrocene_subset"))]
271impl_float_from_bool!(
272    f16;
273    doctest_prefix:
274    // rustdoc doesn't remove the conventional space after the `///`
275    ///#![feature(f16)]
276    ///# #[cfg(all(target_arch = "x86_64", target_os = "linux"))] {
277    ///
278    doctest_suffix:
279    ///# }
280);
281#[cfg(not(feature = "ferrocene_subset"))]
282impl_float_from_bool!(f32);
283#[cfg(not(feature = "ferrocene_subset"))]
284impl_float_from_bool!(f64);
285#[cfg(not(feature = "ferrocene_subset"))]
286impl_float_from_bool!(
287    f128;
288    doctest_prefix:
289    ///#![feature(f128)]
290    ///# #[cfg(all(target_arch = "x86_64", target_os = "linux"))] {
291    ///
292    doctest_suffix:
293    ///# }
294);
295
296// no possible bounds violation
297macro_rules! impl_try_from_unbounded {
298    ($source:ty => $($target:ty),+) => {$(
299        #[stable(feature = "try_from", since = "1.34.0")]
300        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
301        impl const TryFrom<$source> for $target {
302            type Error = TryFromIntError;
303
304            /// Tries to create the target number type from a source
305            /// number type. This returns an error if the source value
306            /// is outside of the range of the target type.
307            #[inline]
308            fn try_from(value: $source) -> Result<Self, Self::Error> {
309                Ok(value as Self)
310            }
311        }
312    )*}
313}
314
315// only negative bounds
316#[cfg(not(feature = "ferrocene_subset"))]
317macro_rules! impl_try_from_lower_bounded {
318    ($source:ty => $($target:ty),+) => {$(
319        #[stable(feature = "try_from", since = "1.34.0")]
320        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
321        impl const TryFrom<$source> for $target {
322            type Error = TryFromIntError;
323
324            /// Tries to create the target number type from a source
325            /// number type. This returns an error if the source value
326            /// is outside of the range of the target type.
327            #[inline]
328            fn try_from(u: $source) -> Result<Self, Self::Error> {
329                if u >= 0 {
330                    Ok(u as Self)
331                } else {
332                    Err(TryFromIntError(()))
333                }
334            }
335        }
336    )*}
337}
338
339// unsigned to signed (only positive bound)
340macro_rules! impl_try_from_upper_bounded {
341    ($source:ty => $($target:ty),+) => {$(
342        #[stable(feature = "try_from", since = "1.34.0")]
343        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
344        impl const TryFrom<$source> for $target {
345            type Error = TryFromIntError;
346
347            /// Tries to create the target number type from a source
348            /// number type. This returns an error if the source value
349            /// is outside of the range of the target type.
350            #[inline]
351            fn try_from(u: $source) -> Result<Self, Self::Error> {
352                if u > (Self::MAX as $source) {
353                    Err(TryFromIntError(()))
354                } else {
355                    Ok(u as Self)
356                }
357            }
358        }
359    )*}
360}
361
362// all other cases
363macro_rules! impl_try_from_both_bounded {
364    ($source:ty => $($target:ty),+) => {$(
365        #[stable(feature = "try_from", since = "1.34.0")]
366        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
367        impl const TryFrom<$source> for $target {
368            type Error = TryFromIntError;
369
370            /// Tries to create the target number type from a source
371            /// number type. This returns an error if the source value
372            /// is outside of the range of the target type.
373            #[inline]
374            fn try_from(u: $source) -> Result<Self, Self::Error> {
375                let min = Self::MIN as $source;
376                let max = Self::MAX as $source;
377                if u < min || u > max {
378                    Err(TryFromIntError(()))
379                } else {
380                    Ok(u as Self)
381                }
382            }
383        }
384    )*}
385}
386
387macro_rules! rev {
388    ($mac:ident, $source:ty => $($target:ty),+) => {$(
389        $mac!($target => $source);
390    )*}
391}
392
393// unsigned integer -> unsigned integer
394impl_try_from_upper_bounded!(u16 => u8);
395impl_try_from_upper_bounded!(u32 => u8, u16);
396impl_try_from_upper_bounded!(u64 => u8, u16, u32);
397impl_try_from_upper_bounded!(u128 => u8, u16, u32, u64);
398
399// signed integer -> signed integer
400#[cfg(not(feature = "ferrocene_subset"))]
401impl_try_from_both_bounded!(i16 => i8);
402#[cfg(not(feature = "ferrocene_subset"))]
403impl_try_from_both_bounded!(i32 => i8, i16);
404#[cfg(not(feature = "ferrocene_subset"))]
405impl_try_from_both_bounded!(i64 => i8, i16, i32);
406#[cfg(not(feature = "ferrocene_subset"))]
407impl_try_from_both_bounded!(i128 => i8, i16, i32, i64);
408
409// unsigned integer -> signed integer
410#[cfg(not(feature = "ferrocene_subset"))]
411impl_try_from_upper_bounded!(u8 => i8);
412#[cfg(not(feature = "ferrocene_subset"))]
413impl_try_from_upper_bounded!(u16 => i8, i16);
414#[cfg(not(feature = "ferrocene_subset"))]
415impl_try_from_upper_bounded!(u32 => i8, i16, i32);
416#[cfg(not(feature = "ferrocene_subset"))]
417impl_try_from_upper_bounded!(u64 => i8, i16, i32, i64);
418#[cfg(not(feature = "ferrocene_subset"))]
419impl_try_from_upper_bounded!(u128 => i8, i16, i32, i64, i128);
420
421// signed integer -> unsigned integer
422#[cfg(not(feature = "ferrocene_subset"))]
423impl_try_from_lower_bounded!(i8 => u8, u16, u32, u64, u128);
424#[cfg(not(feature = "ferrocene_subset"))]
425impl_try_from_both_bounded!(i16 => u8);
426#[cfg(not(feature = "ferrocene_subset"))]
427impl_try_from_lower_bounded!(i16 => u16, u32, u64, u128);
428#[cfg(not(feature = "ferrocene_subset"))]
429impl_try_from_both_bounded!(i32 => u8, u16);
430#[cfg(not(feature = "ferrocene_subset"))]
431impl_try_from_lower_bounded!(i32 => u32, u64, u128);
432#[cfg(not(feature = "ferrocene_subset"))]
433impl_try_from_both_bounded!(i64 => u8, u16, u32);
434#[cfg(not(feature = "ferrocene_subset"))]
435impl_try_from_lower_bounded!(i64 => u64, u128);
436#[cfg(not(feature = "ferrocene_subset"))]
437impl_try_from_both_bounded!(i128 => u8, u16, u32, u64);
438#[cfg(not(feature = "ferrocene_subset"))]
439impl_try_from_lower_bounded!(i128 => u128);
440
441// usize/isize
442#[cfg(not(feature = "ferrocene_subset"))]
443impl_try_from_upper_bounded!(usize => isize);
444#[cfg(not(feature = "ferrocene_subset"))]
445impl_try_from_lower_bounded!(isize => usize);
446
447#[cfg(target_pointer_width = "16")]
448mod ptr_try_from_impls {
449    use super::TryFromIntError;
450
451    impl_try_from_upper_bounded!(usize => u8);
452    impl_try_from_unbounded!(usize => u16, u32, u64, u128);
453    #[cfg(not(feature = "ferrocene_subset"))]
454    impl_try_from_upper_bounded!(usize => i8, i16);
455    #[cfg(not(feature = "ferrocene_subset"))]
456    impl_try_from_unbounded!(usize => i32, i64, i128);
457
458    #[cfg(not(feature = "ferrocene_subset"))]
459    impl_try_from_both_bounded!(isize => u8);
460    #[cfg(not(feature = "ferrocene_subset"))]
461    impl_try_from_lower_bounded!(isize => u16, u32, u64, u128);
462    #[cfg(not(feature = "ferrocene_subset"))]
463    impl_try_from_both_bounded!(isize => i8);
464    #[cfg(not(feature = "ferrocene_subset"))]
465    impl_try_from_unbounded!(isize => i16, i32, i64, i128);
466
467    rev!(impl_try_from_upper_bounded, usize => u32, u64, u128);
468    #[cfg(not(feature = "ferrocene_subset"))]
469    rev!(impl_try_from_lower_bounded, usize => i8, i16);
470    rev!(impl_try_from_both_bounded, usize => i32, i64, i128);
471
472    #[cfg(not(feature = "ferrocene_subset"))]
473    rev!(impl_try_from_upper_bounded, isize => u16, u32, u64, u128);
474    #[cfg(not(feature = "ferrocene_subset"))]
475    rev!(impl_try_from_both_bounded, isize => i32, i64, i128);
476}
477
478#[cfg(target_pointer_width = "32")]
479mod ptr_try_from_impls {
480    use super::TryFromIntError;
481
482    impl_try_from_upper_bounded!(usize => u8, u16);
483    impl_try_from_unbounded!(usize => u32, u64, u128);
484    #[cfg(not(feature = "ferrocene_subset"))]
485    impl_try_from_upper_bounded!(usize => i8, i16, i32);
486    #[cfg(not(feature = "ferrocene_subset"))]
487    impl_try_from_unbounded!(usize => i64, i128);
488
489    #[cfg(not(feature = "ferrocene_subset"))]
490    impl_try_from_both_bounded!(isize => u8, u16);
491    #[cfg(not(feature = "ferrocene_subset"))]
492    impl_try_from_lower_bounded!(isize => u32, u64, u128);
493    #[cfg(not(feature = "ferrocene_subset"))]
494    impl_try_from_both_bounded!(isize => i8, i16);
495    #[cfg(not(feature = "ferrocene_subset"))]
496    impl_try_from_unbounded!(isize => i32, i64, i128);
497
498    rev!(impl_try_from_unbounded, usize => u32);
499    rev!(impl_try_from_upper_bounded, usize => u64, u128);
500    #[cfg(not(feature = "ferrocene_subset"))]
501    rev!(impl_try_from_lower_bounded, usize => i8, i16, i32);
502    rev!(impl_try_from_both_bounded, usize => i64, i128);
503
504    #[cfg(not(feature = "ferrocene_subset"))]
505    rev!(impl_try_from_unbounded, isize => u16);
506    #[cfg(not(feature = "ferrocene_subset"))]
507    rev!(impl_try_from_upper_bounded, isize => u32, u64, u128);
508    #[cfg(not(feature = "ferrocene_subset"))]
509    rev!(impl_try_from_unbounded, isize => i32);
510    #[cfg(not(feature = "ferrocene_subset"))]
511    rev!(impl_try_from_both_bounded, isize => i64, i128);
512}
513
514#[cfg(target_pointer_width = "64")]
515mod ptr_try_from_impls {
516    use super::TryFromIntError;
517
518    impl_try_from_upper_bounded!(usize => u8, u16, u32);
519    impl_try_from_unbounded!(usize => u64, u128);
520    #[cfg(not(feature = "ferrocene_subset"))]
521    impl_try_from_upper_bounded!(usize => i8, i16, i32, i64);
522    #[cfg(not(feature = "ferrocene_subset"))]
523    impl_try_from_unbounded!(usize => i128);
524
525    #[cfg(not(feature = "ferrocene_subset"))]
526    impl_try_from_both_bounded!(isize => u8, u16, u32);
527    #[cfg(not(feature = "ferrocene_subset"))]
528    impl_try_from_lower_bounded!(isize => u64, u128);
529    #[cfg(not(feature = "ferrocene_subset"))]
530    impl_try_from_both_bounded!(isize => i8, i16, i32);
531    #[cfg(not(feature = "ferrocene_subset"))]
532    impl_try_from_unbounded!(isize => i64, i128);
533
534    rev!(impl_try_from_unbounded, usize => u32, u64);
535    rev!(impl_try_from_upper_bounded, usize => u128);
536    #[cfg(not(feature = "ferrocene_subset"))]
537    rev!(impl_try_from_lower_bounded, usize => i8, i16, i32, i64);
538    rev!(impl_try_from_both_bounded, usize => i128);
539
540    #[cfg(not(feature = "ferrocene_subset"))]
541    rev!(impl_try_from_unbounded, isize => u16, u32);
542    #[cfg(not(feature = "ferrocene_subset"))]
543    rev!(impl_try_from_upper_bounded, isize => u64, u128);
544    #[cfg(not(feature = "ferrocene_subset"))]
545    rev!(impl_try_from_unbounded, isize => i32, i64);
546    #[cfg(not(feature = "ferrocene_subset"))]
547    rev!(impl_try_from_both_bounded, isize => i128);
548}
549
550// Conversion traits for non-zero integer types
551#[cfg(not(feature = "ferrocene_subset"))]
552use crate::num::NonZero;
553
554#[cfg(not(feature = "ferrocene_subset"))]
555macro_rules! impl_nonzero_int_from_nonzero_int {
556    ($Small:ty => $Large:ty) => {
557        #[stable(feature = "nz_int_conv", since = "1.41.0")]
558        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
559        impl const From<NonZero<$Small>> for NonZero<$Large> {
560            // Rustdocs on the impl block show a "[+] show undocumented items" toggle.
561            // Rustdocs on functions do not.
562            #[doc = concat!("Converts <code>[NonZero]\\<[", stringify!($Small), "]></code> ")]
563            #[doc = concat!("to <code>[NonZero]\\<[", stringify!($Large), "]></code> losslessly.")]
564            #[inline]
565            fn from(small: NonZero<$Small>) -> Self {
566                // SAFETY: input type guarantees the value is non-zero
567                unsafe { Self::new_unchecked(From::from(small.get())) }
568            }
569        }
570    };
571}
572
573// non-zero unsigned integer -> non-zero unsigned integer
574#[cfg(not(feature = "ferrocene_subset"))]
575impl_nonzero_int_from_nonzero_int!(u8 => u16);
576#[cfg(not(feature = "ferrocene_subset"))]
577impl_nonzero_int_from_nonzero_int!(u8 => u32);
578#[cfg(not(feature = "ferrocene_subset"))]
579impl_nonzero_int_from_nonzero_int!(u8 => u64);
580#[cfg(not(feature = "ferrocene_subset"))]
581impl_nonzero_int_from_nonzero_int!(u8 => u128);
582#[cfg(not(feature = "ferrocene_subset"))]
583impl_nonzero_int_from_nonzero_int!(u8 => usize);
584#[cfg(not(feature = "ferrocene_subset"))]
585impl_nonzero_int_from_nonzero_int!(u16 => u32);
586#[cfg(not(feature = "ferrocene_subset"))]
587impl_nonzero_int_from_nonzero_int!(u16 => u64);
588#[cfg(not(feature = "ferrocene_subset"))]
589impl_nonzero_int_from_nonzero_int!(u16 => u128);
590#[cfg(not(feature = "ferrocene_subset"))]
591impl_nonzero_int_from_nonzero_int!(u16 => usize);
592#[cfg(not(feature = "ferrocene_subset"))]
593impl_nonzero_int_from_nonzero_int!(u32 => u64);
594#[cfg(not(feature = "ferrocene_subset"))]
595impl_nonzero_int_from_nonzero_int!(u32 => u128);
596#[cfg(not(feature = "ferrocene_subset"))]
597impl_nonzero_int_from_nonzero_int!(u64 => u128);
598
599// non-zero signed integer -> non-zero signed integer
600#[cfg(not(feature = "ferrocene_subset"))]
601impl_nonzero_int_from_nonzero_int!(i8 => i16);
602#[cfg(not(feature = "ferrocene_subset"))]
603impl_nonzero_int_from_nonzero_int!(i8 => i32);
604#[cfg(not(feature = "ferrocene_subset"))]
605impl_nonzero_int_from_nonzero_int!(i8 => i64);
606#[cfg(not(feature = "ferrocene_subset"))]
607impl_nonzero_int_from_nonzero_int!(i8 => i128);
608#[cfg(not(feature = "ferrocene_subset"))]
609impl_nonzero_int_from_nonzero_int!(i8 => isize);
610#[cfg(not(feature = "ferrocene_subset"))]
611impl_nonzero_int_from_nonzero_int!(i16 => i32);
612#[cfg(not(feature = "ferrocene_subset"))]
613impl_nonzero_int_from_nonzero_int!(i16 => i64);
614#[cfg(not(feature = "ferrocene_subset"))]
615impl_nonzero_int_from_nonzero_int!(i16 => i128);
616#[cfg(not(feature = "ferrocene_subset"))]
617impl_nonzero_int_from_nonzero_int!(i16 => isize);
618#[cfg(not(feature = "ferrocene_subset"))]
619impl_nonzero_int_from_nonzero_int!(i32 => i64);
620#[cfg(not(feature = "ferrocene_subset"))]
621impl_nonzero_int_from_nonzero_int!(i32 => i128);
622#[cfg(not(feature = "ferrocene_subset"))]
623impl_nonzero_int_from_nonzero_int!(i64 => i128);
624
625// non-zero unsigned -> non-zero signed integer
626#[cfg(not(feature = "ferrocene_subset"))]
627impl_nonzero_int_from_nonzero_int!(u8 => i16);
628#[cfg(not(feature = "ferrocene_subset"))]
629impl_nonzero_int_from_nonzero_int!(u8 => i32);
630#[cfg(not(feature = "ferrocene_subset"))]
631impl_nonzero_int_from_nonzero_int!(u8 => i64);
632#[cfg(not(feature = "ferrocene_subset"))]
633impl_nonzero_int_from_nonzero_int!(u8 => i128);
634#[cfg(not(feature = "ferrocene_subset"))]
635impl_nonzero_int_from_nonzero_int!(u8 => isize);
636#[cfg(not(feature = "ferrocene_subset"))]
637impl_nonzero_int_from_nonzero_int!(u16 => i32);
638#[cfg(not(feature = "ferrocene_subset"))]
639impl_nonzero_int_from_nonzero_int!(u16 => i64);
640#[cfg(not(feature = "ferrocene_subset"))]
641impl_nonzero_int_from_nonzero_int!(u16 => i128);
642#[cfg(not(feature = "ferrocene_subset"))]
643impl_nonzero_int_from_nonzero_int!(u32 => i64);
644#[cfg(not(feature = "ferrocene_subset"))]
645impl_nonzero_int_from_nonzero_int!(u32 => i128);
646#[cfg(not(feature = "ferrocene_subset"))]
647impl_nonzero_int_from_nonzero_int!(u64 => i128);
648
649#[cfg(not(feature = "ferrocene_subset"))]
650macro_rules! impl_nonzero_int_try_from_int {
651    ($Int:ty) => {
652        #[stable(feature = "nzint_try_from_int_conv", since = "1.46.0")]
653        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
654        impl const TryFrom<$Int> for NonZero<$Int> {
655            type Error = TryFromIntError;
656
657            // Rustdocs on the impl block show a "[+] show undocumented items" toggle.
658            // Rustdocs on functions do not.
659            #[doc = concat!("Attempts to convert [`", stringify!($Int), "`] ")]
660            #[doc = concat!("to <code>[NonZero]\\<[", stringify!($Int), "]></code>.")]
661            #[inline]
662            fn try_from(value: $Int) -> Result<Self, Self::Error> {
663                Self::new(value).ok_or(TryFromIntError(()))
664            }
665        }
666    };
667}
668
669// integer -> non-zero integer
670#[cfg(not(feature = "ferrocene_subset"))]
671impl_nonzero_int_try_from_int!(u8);
672#[cfg(not(feature = "ferrocene_subset"))]
673impl_nonzero_int_try_from_int!(u16);
674#[cfg(not(feature = "ferrocene_subset"))]
675impl_nonzero_int_try_from_int!(u32);
676#[cfg(not(feature = "ferrocene_subset"))]
677impl_nonzero_int_try_from_int!(u64);
678#[cfg(not(feature = "ferrocene_subset"))]
679impl_nonzero_int_try_from_int!(u128);
680#[cfg(not(feature = "ferrocene_subset"))]
681impl_nonzero_int_try_from_int!(usize);
682#[cfg(not(feature = "ferrocene_subset"))]
683impl_nonzero_int_try_from_int!(i8);
684#[cfg(not(feature = "ferrocene_subset"))]
685impl_nonzero_int_try_from_int!(i16);
686#[cfg(not(feature = "ferrocene_subset"))]
687impl_nonzero_int_try_from_int!(i32);
688#[cfg(not(feature = "ferrocene_subset"))]
689impl_nonzero_int_try_from_int!(i64);
690#[cfg(not(feature = "ferrocene_subset"))]
691impl_nonzero_int_try_from_int!(i128);
692#[cfg(not(feature = "ferrocene_subset"))]
693impl_nonzero_int_try_from_int!(isize);
694
695#[cfg(not(feature = "ferrocene_subset"))]
696macro_rules! impl_nonzero_int_try_from_nonzero_int {
697    ($source:ty => $($target:ty),+) => {$(
698        #[stable(feature = "nzint_try_from_nzint_conv", since = "1.49.0")]
699        #[rustc_const_unstable(feature = "const_convert", issue = "143773")]
700        impl const TryFrom<NonZero<$source>> for NonZero<$target> {
701            type Error = TryFromIntError;
702
703            // Rustdocs on the impl block show a "[+] show undocumented items" toggle.
704            // Rustdocs on functions do not.
705            #[doc = concat!("Attempts to convert <code>[NonZero]\\<[", stringify!($source), "]></code> ")]
706            #[doc = concat!("to <code>[NonZero]\\<[", stringify!($target), "]></code>.")]
707            #[inline]
708            fn try_from(value: NonZero<$source>) -> Result<Self, Self::Error> {
709                // SAFETY: Input is guaranteed to be non-zero.
710                Ok(unsafe { Self::new_unchecked(<$target>::try_from(value.get())?) })
711            }
712        }
713    )*};
714}
715
716// unsigned non-zero integer -> unsigned non-zero integer
717#[cfg(not(feature = "ferrocene_subset"))]
718impl_nonzero_int_try_from_nonzero_int!(u16 => u8);
719#[cfg(not(feature = "ferrocene_subset"))]
720impl_nonzero_int_try_from_nonzero_int!(u32 => u8, u16, usize);
721#[cfg(not(feature = "ferrocene_subset"))]
722impl_nonzero_int_try_from_nonzero_int!(u64 => u8, u16, u32, usize);
723#[cfg(not(feature = "ferrocene_subset"))]
724impl_nonzero_int_try_from_nonzero_int!(u128 => u8, u16, u32, u64, usize);
725#[cfg(not(feature = "ferrocene_subset"))]
726impl_nonzero_int_try_from_nonzero_int!(usize => u8, u16, u32, u64, u128);
727
728// signed non-zero integer -> signed non-zero integer
729#[cfg(not(feature = "ferrocene_subset"))]
730impl_nonzero_int_try_from_nonzero_int!(i16 => i8);
731#[cfg(not(feature = "ferrocene_subset"))]
732impl_nonzero_int_try_from_nonzero_int!(i32 => i8, i16, isize);
733#[cfg(not(feature = "ferrocene_subset"))]
734impl_nonzero_int_try_from_nonzero_int!(i64 => i8, i16, i32, isize);
735#[cfg(not(feature = "ferrocene_subset"))]
736impl_nonzero_int_try_from_nonzero_int!(i128 => i8, i16, i32, i64, isize);
737#[cfg(not(feature = "ferrocene_subset"))]
738impl_nonzero_int_try_from_nonzero_int!(isize => i8, i16, i32, i64, i128);
739
740// unsigned non-zero integer -> signed non-zero integer
741#[cfg(not(feature = "ferrocene_subset"))]
742impl_nonzero_int_try_from_nonzero_int!(u8 => i8);
743#[cfg(not(feature = "ferrocene_subset"))]
744impl_nonzero_int_try_from_nonzero_int!(u16 => i8, i16, isize);
745#[cfg(not(feature = "ferrocene_subset"))]
746impl_nonzero_int_try_from_nonzero_int!(u32 => i8, i16, i32, isize);
747#[cfg(not(feature = "ferrocene_subset"))]
748impl_nonzero_int_try_from_nonzero_int!(u64 => i8, i16, i32, i64, isize);
749#[cfg(not(feature = "ferrocene_subset"))]
750impl_nonzero_int_try_from_nonzero_int!(u128 => i8, i16, i32, i64, i128, isize);
751#[cfg(not(feature = "ferrocene_subset"))]
752impl_nonzero_int_try_from_nonzero_int!(usize => i8, i16, i32, i64, i128, isize);
753
754// signed non-zero integer -> unsigned non-zero integer
755#[cfg(not(feature = "ferrocene_subset"))]
756impl_nonzero_int_try_from_nonzero_int!(i8 => u8, u16, u32, u64, u128, usize);
757#[cfg(not(feature = "ferrocene_subset"))]
758impl_nonzero_int_try_from_nonzero_int!(i16 => u8, u16, u32, u64, u128, usize);
759#[cfg(not(feature = "ferrocene_subset"))]
760impl_nonzero_int_try_from_nonzero_int!(i32 => u8, u16, u32, u64, u128, usize);
761#[cfg(not(feature = "ferrocene_subset"))]
762impl_nonzero_int_try_from_nonzero_int!(i64 => u8, u16, u32, u64, u128, usize);
763#[cfg(not(feature = "ferrocene_subset"))]
764impl_nonzero_int_try_from_nonzero_int!(i128 => u8, u16, u32, u64, u128, usize);
765#[cfg(not(feature = "ferrocene_subset"))]
766impl_nonzero_int_try_from_nonzero_int!(isize => u8, u16, u32, u64, u128, usize);
core/convert/num.rs

core/convert/
num.rs
