Struct std::num::NonZeroI16
1.34.0· source · [−]#[repr(transparent)]pub struct NonZeroI16(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroI16>
is the same size as i16
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroI16>>(), size_of::<i16>());
RunImplementations
Creates a non-zero without checking whether the value is non-zero. This results in undefined behaviour if the value is zero.
Safety
The value must not be zero.
Creates a non-zero if the given value is not zero.
Returns the number of leading zeros in the binary representation of self
.
On many architectures, this function can perform better than leading_zeros()
on the underlying integer type, as special handling of zero can be avoided.
Examples
Basic usage:
let n = std::num::NonZeroI16::new(-1i16).unwrap();
assert_eq!(n.leading_zeros(), 0);
RunReturns the number of trailing zeros in the binary representation
of self
.
On many architectures, this function can perform better than trailing_zeros()
on the underlying integer type, as special handling of zero can be avoided.
Examples
Basic usage:
let n = std::num::NonZeroI16::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
RunChecked absolute value.
Check for overflow and returns None
if
self == i16::MIN
.
The result cannot be zero.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;
assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());
RunComputes the absolute value of self,
with overflow information, see
i16::overflowing_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;
assert_eq!((pos, false), pos.overflowing_abs());
assert_eq!((pos, false), neg.overflowing_abs());
assert_eq!((min, true), min.overflowing_abs());
RunSaturating absolute value, see
i16::saturating_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;
let min_plus = NonZeroI16::new(i16::MIN + 1)?;
let max = NonZeroI16::new(i16::MAX)?;
assert_eq!(pos, pos.saturating_abs());
assert_eq!(pos, neg.saturating_abs());
assert_eq!(max, min.saturating_abs());
assert_eq!(max, min_plus.saturating_abs());
RunWrapping absolute value, see
i16::wrapping_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;
let max = NonZeroI16::new(i16::MAX)?;
assert_eq!(pos, pos.wrapping_abs());
assert_eq!(pos, neg.wrapping_abs());
assert_eq!(min, min.wrapping_abs());
RunComputes the absolute value of self without any wrapping or panicking.
Example
#![feature(nonzero_ops)]
let u_pos = NonZeroU16::new(1)?;
let i_pos = NonZeroI16::new(1)?;
let i_neg = NonZeroI16::new(-1)?;
let i_min = NonZeroI16::new(i16::MIN)?;
let u_max = NonZeroU16::new(u16::MAX / 2 + 1)?;
assert_eq!(u_pos, i_pos.unsigned_abs());
assert_eq!(u_pos, i_neg.unsigned_abs());
assert_eq!(u_max, i_min.unsigned_abs());
RunMultiply two non-zero integers together.
Check for overflow and return None
on overflow.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let two = NonZeroI16::new(2)?;
let four = NonZeroI16::new(4)?;
let max = NonZeroI16::new(i16::MAX)?;
assert_eq!(Some(four), two.checked_mul(two));
assert_eq!(None, max.checked_mul(two));
RunMultiply two non-zero integers together,
assuming overflow cannot occur.
Overflow is unchecked, and it is undefined behaviour to overflow
even if the result would wrap to a non-zero value.
The behaviour is undefined as soon as
self * rhs > i16::MAX
, or self * rhs < i16::MIN
.
Examples
#![feature(nonzero_ops)]
let two = NonZeroI16::new(2)?;
let four = NonZeroI16::new(4)?;
assert_eq!(four, unsafe { two.unchecked_mul(two) });
RunRaise non-zero value to an integer power.
Check for overflow and return None
on overflow.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let three = NonZeroI16::new(3)?;
let twenty_seven = NonZeroI16::new(27)?;
let half_max = NonZeroI16::new(i16::MAX / 2)?;
assert_eq!(Some(twenty_seven), three.checked_pow(3));
assert_eq!(None, half_max.checked_pow(3));
RunRaise non-zero value to an integer power.
Return i16::MIN
or i16::MAX
on overflow.
Examples
#![feature(nonzero_ops)]
let three = NonZeroI16::new(3)?;
let twenty_seven = NonZeroI16::new(27)?;
let max = NonZeroI16::new(i16::MAX)?;
assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));
RunTrait Implementations
type Output = NonZeroI16
type Output = NonZeroI16
The resulting type after applying the |
operator.
Performs the |
operation. Read more
type Output = NonZeroI16
type Output = NonZeroI16
The resulting type after applying the |
operator.
pub fn bitor(self, rhs: NonZeroI16) -> <NonZeroI16 as BitOr<NonZeroI16>>::Output
pub fn bitor(self, rhs: NonZeroI16) -> <NonZeroI16 as BitOr<NonZeroI16>>::Output
Performs the |
operation. Read more
Performs the |=
operation. Read more
Performs the |=
operation. Read more
Converts NonZeroI16
to NonZeroIsize
losslessly.
Converts NonZeroI16
to NonZeroI64
losslessly.
Converts NonZeroI16
to NonZeroI128
losslessly.
Converts a NonZeroI16
into an i16
Converts NonZeroI16
to NonZeroI32
losslessly.
Converts NonZeroI8
to NonZeroI16
losslessly.
Converts NonZeroU8
to NonZeroI16
losslessly.
type Err = ParseIntError
type Err = ParseIntError
The associated error which can be returned from parsing.
Parses a string s
to return a value of this type. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI128>>::Error>
pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI128>>::Error>
Attempts to convert NonZeroI128
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroUsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU128
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroI16>>::Error>
pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroI8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI32>>::Error>
pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI32>>::Error>
Attempts to convert NonZeroI32
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroIsize>>::Error>
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroIsize>>::Error>
Attempts to convert NonZeroIsize
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU128>>::Error>
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU16>>::Error>
pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU16>>::Error>
Attempts to convert NonZeroU16
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU32>>::Error>
pub fn try_from(
value: NonZeroU32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU32>>::Error>
Attempts to convert NonZeroU32
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU64>>::Error>
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU64>>::Error>
Attempts to convert NonZeroU64
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroUsize>>::Error>
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroUsize>>::Error>
Attempts to convert NonZeroUsize
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
Attempts to convert i16
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.