Rollup merge of #144797 - nilehmann:safety-comment-niche, r=Noratrieb
Update safety comment for new_unchecked in niche_types Change the safety comment on `new_unchecked` to mention the valid range instead of 0. I noticed this while working on https://github.com/model-checking/verify-rust-std
This commit is contained in:
@@ -46,11 +46,11 @@ macro_rules! define_valid_range_type {
|
||||
/// primitive without checking whether its zero.
|
||||
///
|
||||
/// # Safety
|
||||
/// Immediate language UB if `val == 0`, as it violates the validity
|
||||
/// invariant of this type.
|
||||
/// Immediate language UB if `val` is not within the valid range for this
|
||||
/// type, as it violates the validity invariant.
|
||||
#[inline]
|
||||
pub const unsafe fn new_unchecked(val: $int) -> Self {
|
||||
// SAFETY: Caller promised that `val` is non-zero.
|
||||
// SAFETY: Caller promised that `val` is within the valid range.
|
||||
unsafe { $name(val) }
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user