Struct std::num::NonZeroI64
1.34.0·
source ·
[−]#[repr(transparent)]pub struct NonZeroI64(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroI64>
is the same size as i64
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroI64>>(), size_of::<i64>());
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::NonZeroI64::new(-1i64).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::NonZeroI64::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
RunChecked absolute value.
Check for overflow and returns None
if
self == i64::MIN
.
The result cannot be zero.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;
assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());
RunComputes the absolute value of self,
with overflow information, see
i64::overflowing_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::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
i64::saturating_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;
let min_plus = NonZeroI64::new(i64::MIN + 1)?;
let max = NonZeroI64::new(i64::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
i64::wrapping_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;
let max = NonZeroI64::new(i64::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 = NonZeroU64::new(1)?;
let i_pos = NonZeroI64::new(1)?;
let i_neg = NonZeroI64::new(-1)?;
let i_min = NonZeroI64::new(i64::MIN)?;
let u_max = NonZeroU64::new(u64::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 = NonZeroI64::new(2)?;
let four = NonZeroI64::new(4)?;
let max = NonZeroI64::new(i64::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 > i64::MAX
, or self * rhs < i64::MIN
.
Examples
#![feature(nonzero_ops)]
let two = NonZeroI64::new(2)?;
let four = NonZeroI64::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 = NonZeroI64::new(3)?;
let twenty_seven = NonZeroI64::new(27)?;
let half_max = NonZeroI64::new(i64::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 i64::MIN
or i64::MAX
on overflow.
Examples
#![feature(nonzero_ops)]
let three = NonZeroI64::new(3)?;
let twenty_seven = NonZeroI64::new(27)?;
let max = NonZeroI64::new(i64::MAX)?;
assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));
RunTrait Implementations
type Output = NonZeroI64
type Output = NonZeroI64
The resulting type after applying the |
operator.
Performs the |
operation. Read more
type Output = NonZeroI64
type Output = NonZeroI64
The resulting type after applying the |
operator.
Performs the |
operation. Read more
type Output = NonZeroI64
type Output = NonZeroI64
The resulting type after applying the |
operator.
Performs the |=
operation. Read more
Performs the |=
operation. Read more
Converts NonZeroI16
to NonZeroI64
losslessly.
Converts NonZeroI32
to NonZeroI64
losslessly.
Converts NonZeroI64
to NonZeroI128
losslessly.
Converts a NonZeroI64
into an i64
Converts NonZeroI8
to NonZeroI64
losslessly.
Converts NonZeroU16
to NonZeroI64
losslessly.
Converts NonZeroU32
to NonZeroI64
losslessly.
Converts NonZeroU8
to NonZeroI64
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<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroI128>>::Error>
pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroI128>>::Error>
Attempts to convert NonZeroI128
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroIsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU128
.
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: NonZeroI64
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroUsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroI8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI64>>::Error>
pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroIsize>>::Error>
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroIsize>>::Error>
Attempts to convert NonZeroIsize
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU128>>::Error>
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU64>>::Error>
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU64>>::Error>
Attempts to convert NonZeroU64
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroUsize>>::Error>
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroUsize>>::Error>
Attempts to convert NonZeroUsize
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
Attempts to convert i64
to NonZeroI64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.