Struct rocket_governor::NonZeroU32 1.28.0[−][src]
#[repr(transparent)]pub struct NonZeroU32(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroU32>
is the same size as u32
:
use std::mem::size_of; assert_eq!(size_of::<Option<core::num::NonZeroU32>>(), size_of::<u32>());
Implementations
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::NonZeroU32::new(u32::MAX).unwrap(); assert_eq!(n.leading_zeros(), 0);
Returns 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::NonZeroU32::new(0b0101000).unwrap(); assert_eq!(n.trailing_zeros(), 3);
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Add an unsigned integer to a non-zero value.
Check for overflow and return None
on overflow
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)] let one = NonZeroU32::new(1)?; let two = NonZeroU32::new(2)?; let max = NonZeroU32::new(u32::MAX)?; assert_eq!(Some(two), one.checked_add(1)); assert_eq!(None, max.checked_add(1));
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Add an unsigned integer to a non-zero value,
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 > u32::MAX
.
Examples
#![feature(nonzero_ops)] let one = NonZeroU32::new(1)?; let two = NonZeroU32::new(2)?; assert_eq!(two, unsafe { one.unchecked_add(1) });
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Returns the smallest power of two greater than or equal to n.
Check for overflow and return None
if the next power of two is greater than the type’s maximum value.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)] let two = NonZeroU32::new(2)?; let three = NonZeroU32::new(3)?; let four = NonZeroU32::new(4)?; let max = NonZeroU32::new(u32::MAX)?; assert_eq!(Some(two), two.checked_next_power_of_two() ); assert_eq!(Some(four), three.checked_next_power_of_two() ); assert_eq!(None, max.checked_next_power_of_two() );
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Multiply 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 = NonZeroU32::new(2)?; let four = NonZeroU32::new(4)?; let max = NonZeroU32::new(u32::MAX)?; assert_eq!(Some(four), two.checked_mul(two)); assert_eq!(None, max.checked_mul(two));
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Multiply 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 > u32::MAX
.
Examples
#![feature(nonzero_ops)] let two = NonZeroU32::new(2)?; let four = NonZeroU32::new(4)?; assert_eq!(four, unsafe { two.unchecked_mul(two) });
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Raise 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 = NonZeroU32::new(3)?; let twenty_seven = NonZeroU32::new(27)?; let half_max = NonZeroU32::new(u32::MAX / 2)?; assert_eq!(Some(twenty_seven), three.checked_pow(3)); assert_eq!(None, half_max.checked_pow(3));
🔬 This is a nightly-only experimental API. (nonzero_ops
)
nonzero_ops
)Raise non-zero value to an integer power.
Return u32::MAX
on overflow.
Examples
#![feature(nonzero_ops)] let three = NonZeroU32::new(3)?; let twenty_seven = NonZeroU32::new(27)?; let max = NonZeroU32::new(u32::MAX)?; assert_eq!(twenty_seven, three.saturating_pow(3)); assert_eq!(max, max.saturating_pow(3));
🔬 This is a nightly-only experimental API. (nonzero_is_power_of_two
)
nonzero_is_power_of_two
)Returns true
if and only if self == (1 << k)
for some k
.
On many architectures, this function can perform better than is_power_of_two()
on the underlying integer type, as special handling of zero can be avoided.
Examples
Basic usage:
#![feature(nonzero_is_power_of_two)] let eight = std::num::NonZeroU32::new(8).unwrap(); assert!(eight.is_power_of_two()); let ten = std::num::NonZeroU32::new(10).unwrap(); assert!(!ten.is_power_of_two());
Trait Implementations
type Output = NonZeroU32
type Output = NonZeroU32
The resulting type after applying the |
operator.
Performs the |
operation. Read more
type Output = NonZeroU32
type Output = NonZeroU32
The resulting type after applying the |
operator.
Performs the |=
operation. Read more
Performs the |=
operation. Read more
pub fn deserialize<D>(
deserializer: D
) -> Result<NonZeroU32, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<NonZeroU32, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Converts NonZeroU16
to NonZeroU32
losslessly.
Converts NonZeroU8
to NonZeroU32
losslessly.
Parses and validates an instance of Self
from a path parameter string
or returns an Error
if parsing or validation fails. Read more
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
impl NonZero for NonZeroU32
impl NonZero for NonZeroU32
pub fn new(n: u32) -> Option<NonZeroU32>
pub fn new(n: u32) -> Option<NonZeroU32>
Creates a new non-zero object from an integer that might be zero. Read more
pub fn get(self) -> <NonZeroU32 as NonZero>::Primitive
pub fn get(self) -> <NonZeroU32 as NonZero>::Primitive
Returns the value as a primitive type.
impl NumericalDuration for NonZeroU32
impl NumericalDuration for NonZeroU32
pub fn nanoseconds(self) -> Duration
pub fn nanoseconds(self) -> Duration
Create a Duration
from the number of nanoseconds.
pub fn microseconds(self) -> Duration
pub fn microseconds(self) -> Duration
Create a Duration
from the number of microseconds.
pub fn milliseconds(self) -> Duration
pub fn milliseconds(self) -> Duration
Create a Duration
from the number of milliseconds.
pub fn seconds(self) -> Duration
pub fn seconds(self) -> Duration
Create a Duration
from the number of seconds.
pub fn minutes(self) -> Duration
pub fn minutes(self) -> Duration
Create a Duration
from the number of minutes.
pub fn hours(self) -> Duration
pub fn hours(self) -> Duration
Create a Duration
from the number of hours.
pub fn days(self) -> Duration
pub fn days(self) -> Duration
Create a Duration
from the number of days.
pub fn weeks(self) -> Duration
pub fn weeks(self) -> Duration
Create a Duration
from the number of weeks.
impl NumericalStdDuration for NonZeroU32
impl NumericalStdDuration for NonZeroU32
pub fn std_nanoseconds(self) -> Duration
pub fn std_nanoseconds(self) -> Duration
Create a std::time::Duration
from the number of nanoseconds.
pub fn std_microseconds(self) -> Duration
pub fn std_microseconds(self) -> Duration
Create a std::time::Duration
from the number of microseconds.
pub fn std_milliseconds(self) -> Duration
pub fn std_milliseconds(self) -> Duration
Create a std::time::Duration
from the number of milliseconds.
pub fn std_seconds(self) -> Duration
pub fn std_seconds(self) -> Duration
Create a std::time::Duration
from the number of seconds.
pub fn std_minutes(self) -> Duration
pub fn std_minutes(self) -> Duration
Create a std::time::Duration
from the number of minutes.
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 serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI128>>::Error>
pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI128>>::Error>
Attempts to convert NonZeroI128
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<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: NonZeroI32
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI32>>::Error>
pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI32>>::Error>
Attempts to convert NonZeroI32
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<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: NonZeroI8
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI8>>::Error>
pub fn try_from(
value: NonZeroI8
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI8>>::Error>
Attempts to convert NonZeroI8
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroIsize>>::Error>
pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroIsize>>::Error>
Attempts to convert NonZeroIsize
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU128>>::Error>
pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU64>>::Error>
pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU64>>::Error>
Attempts to convert NonZeroU64
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroUsize>>::Error>
pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroUsize>>::Error>
Attempts to convert NonZeroUsize
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
Attempts to convert u32
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
Auto Trait Implementations
impl RefUnwindSafe for NonZeroU32
impl Send for NonZeroU32
impl Sync for NonZeroU32
impl Unpin for NonZeroU32
impl UnwindSafe for NonZeroU32
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
pub fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
Converts self
into a collection.
pub fn nanoseconds(self) -> Duration
pub fn nanoseconds(self) -> Duration
Create a std::time::Duration
from the number of nanoseconds.
pub fn microseconds(self) -> Duration
pub fn microseconds(self) -> Duration
Create a std::time::Duration
from the number of microseconds.
pub fn milliseconds(self) -> Duration
pub fn milliseconds(self) -> Duration
Create a std::time::Duration
from the number of milliseconds.
pub fn vzip(self) -> V