Skip to content

Commit 185ae69

Browse files
committed
add doc for NonZero* const creation
1 parent f6092f2 commit 185ae69

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

library/core/src/num/nonzero.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,18 @@ macro_rules! nonzero_integer {
548548
#[doc = concat!("assert_eq!(align_of::<", stringify!($Ty), ">(), align_of::<Option<", stringify!($Ty), ">>());")]
549549
/// ```
550550
///
551+
/// # Compile-time creation
552+
///
553+
/// Since both [`Option::unwrap()`] and [`Option::expect()`] are `const`, it is possible to
554+
/// define a new
555+
#[doc = concat!("`", stringify!($Ty), "`")]
556+
/// at compile time via:
557+
/// ```
558+
#[doc = concat!("use std::num::", stringify!($Ty), ";")]
559+
///
560+
#[doc = concat!("const TEN: ", stringify!($Ty), " = ", stringify!($Ty) , r#"::new(10).expect("ten is non-zero");"#)]
561+
/// ```
562+
///
551563
/// [null pointer optimization]: crate::option#representation
552564
#[$stability]
553565
pub type $Ty = NonZero<$Int>;

0 commit comments

Comments
 (0)