Struct NonZeroPow2Usize 

pub struct NonZeroPow2Usize(/* private fields */);

An integer that is known to be a power of two with nonzero exponent.

The integer is equal to 2^n for some n > 0.

The integer is strictly greater than 1.

Implementations

impl NonZeroPow2Usize

pub const TWO: Self

Smallest power of two with nonzero exponent.

pub const fn new(n: usize) -> Option<Self>

Create a power of two with nonzero exponent.

pub const fn new_unchecked(n: usize) -> Self

Create a power of two with nonzero exponent.

Precondition

The value must be a power of two with nonzero exponent.

Panics

Panics may occur down the line if the precondition is not satisfied.

pub const fn log2(self) -> NonZeroU32

Return the binary logarithm of the value.

The integer is equal to 2^n for some n > 0. Return n.

pub const fn mul2(self) -> Self

Multiply the value by two. Return the next power of two.

The integer is equal to 2^n for some n > 0. Return 2^(n + 1).

pub const fn checked_div2(self) -> Option<Self>

Divide the value by two. Return the previous power of two with nonzero exponent, if it exists.

• If the integer is equal to 2^(n + 1) for some n > 0, then return Some(2^n).
• If the integer is equal to 2^1, then return None.

impl NonZeroPow2Usize

pub const fn get(&self) -> usize

Access the value as a primitive type.

Trait Implementations

impl Clone for NonZeroPow2Usize

fn clone(&self) -> NonZeroPow2Usize

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NonZeroPow2Usize

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for NonZeroPow2Usize

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<NonZeroPow2Usize> for Pow2Usize

fn from(value: NonZeroPow2Usize) -> Self

Converts to this type from the input type.

impl FromStr for NonZeroPow2Usize

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NonZeroPow2Usize

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NonZeroPow2Usize

fn cmp(&self, other: &NonZeroPow2Usize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NonZeroPow2Usize

fn eq(&self, other: &NonZeroPow2Usize) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NonZeroPow2Usize

fn partial_cmp(&self, other: &NonZeroPow2Usize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NonZeroPow2Usize

impl Eq for NonZeroPow2Usize

impl StructuralPartialEq for NonZeroPow2Usize