Skip to content

Implemented MIN and MAX constants for the non-zero integer types.#89065 #89077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from
Closed

Implemented MIN and MAX constants for the non-zero integer types.#89065 #89077

Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0156ef1
Max working.
mjclements Sep 18, 2021
b5c1fe1
nonzero min and nonzero max working.
mjclements Sep 18, 2021
84d88f2
Fixed some formatting issues.
mjclements Sep 18, 2021
b274022
Made a macro name consistent.
mjclements Sep 18, 2021
0f84d19
Fixed variable name _properly_
mjclements Sep 18, 2021
279f0bf
Fixed build errors.
mjclements Sep 18, 2021
591b89d
Addressing PR Comment.
mjclements Sep 20, 2021
56ce3a2
Removed {unsafe} since we are in constant context.
mjclements Sep 20, 2021
3cbfdec
Split macro, added documentation.
mjclements Sep 22, 2021
7a718e1
Trailing ws.
mjclements Sep 23, 2021
87d92f9
Tidy cleanup comment, trailing WS
mjclements Sep 23, 2021
2fecb01
Update library/core/src/num/nonzero.rs
mjclements Sep 24, 2021
5b48c54
Cleaned up some documentation.
mjclements Sep 25, 2021
5ac53ef
Fixes missing parenthesis in doc test.
mjclements Sep 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions library/core/src/num/nonzero.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,3 +895,63 @@ macro_rules! nonzero_unsigned_is_power_of_two {
}

nonzero_unsigned_is_power_of_two! { NonZeroU8 NonZeroU16 NonZeroU32 NonZeroU64 NonZeroU128 NonZeroUsize }

macro_rules! nonzero_constants_signed {
( $( $Ty: ident($Int: ty); )+ ) => {
$(
impl $Ty {
#[unstable(feature = "nonzero_min_max", issue = "89065")]
#[doc = concat!("The maximum value for a`", stringify!($Ty), "` is the same as `", stringify!($Int), "`")]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In for a`", there should be a space between a and `, and the sentence needs a period at the end.

/// # Examples
#[doc = concat!("assert_eq!(", stringify!($Ty), "::MAX, ", stringify!($Int), "::MAX);")]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this and the below example need a ``` ... ``` code block, for formatting (though they're not very interesting as doctests).

I think including some blank lines as done above for nonzero_unsigned_signed_operations (such as ``` above and below the Examples header, and a normal blank line between the MAX and MIN definitions) but before would also make the macro code more readable even if it doesn't affect the documentation output.

pub const MAX : $Ty = $Ty::new(<$Int>::MAX).unwrap() ;
#[unstable(feature = "nonzero_min_max", issue = "89065")]
#[doc = concat!("The minimum value for a`", stringify!($Ty), "`.")]
/// # Examples
#[doc = concat!("assert_eq!(", stringify!($Ty), "::MIN, ", stringify!($Int), "::MIN;")]
pub const MIN : $Ty = $Ty::new(<$Int>::MIN).unwrap();
}
)+
}
}

nonzero_constants_signed! {
NonZeroI8(i8);
NonZeroI16(i16);
NonZeroI32(i32);
NonZeroI64(i64);
NonZeroI128(i128);
NonZeroIsize(isize);
}

macro_rules! nonzero_constants_unsigned{
( $( $Ty: ident($Int: ty); )+ ) => {
$(
impl $Ty {
#[unstable(feature = "nonzero_min_max", issue = "89065")]
#[doc = concat!("The maximum value for a`", stringify!($Ty), "` is the same as `", stringify!($Int), "`")]
#[doc = concat!("assert_eq!(", stringify!($Ty), "::MAX, ", stringify!($Int), "::MAX);")]
/// Note, while most integer types are defined for every whole number between MIN and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be either Note that, while or Note: while rather than Note, while, but I'm not sure whether others would agree with that grammar nitpick.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'd vote for Note: While with a capital W.

/// MAX, signed non-zero integers are a special case. They have a 'gap' at 0.
/// # Examples
pub const MAX : $Ty = $Ty::new(<$Int>::MAX).unwrap() ;
#[unstable(feature = "nonzero_min_max", issue = "89065")]
#[doc = concat!("The minimum value for a`", stringify!($Ty), "`.")]
/// Note, while most integer types are defined for every whole number between MIN and
/// MAX, signed non-zero integers are a special case. They have a 'gap' at 0.
/// # Examples
#[doc = concat!("assert_eq!(", stringify!($Ty), "::MIN, ", stringify!($Int), "::MIN;")]
pub const MIN : $Ty = $Ty::new(1).unwrap();
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation looks off here. Did the formatter really demand it like that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a macro, it should be formatted manually.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have specific advice on how to format it? I noticed that macros needed manual formatting. Wasn't sure if I had it right though @ibraheemdev .

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This closing brace, and the analogous one in nonzero_constants_signed should be unindented by one level = four spaces. The rest looks fine.

)+
}
}

nonzero_constants_unsigned! {
NonZeroU8(u8);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation mismatch here.

NonZeroU16(u16);
NonZeroU32(u32);
NonZeroU64(u64);
NonZeroU128(u128);
NonZeroUsize(usize);
}