Struct PowerOfTwo64 

pub struct PowerOfTwo64 { /* private fields */ }

Represents a power of two, as a 64-bit value, which includes zero.

Implementations

impl PowerOfTwo64

pub const ZERO: Self

Represents PowerOfTwo64 zero.

pub const unsafe fn new_unchecked(value: u64) -> Self

Creates a new PowerOfTwo64 from a 64-bit value.

Safety

This function does not validate value. It is up to the caller to ensure that its value is a power of two.

pub const fn new(value: u64) -> Result<Self, PowerOfTwoError>

Creates a new PowerOfTwo64 from a 64-bit value.

Errors

Returns PowerOfTwoError::NotAPowerOfTwo if value is not a power of two.

pub fn next(self) -> Self

Returns the next power of two.

Panics

Panics in debug mode if the next power of two is greater than u64::MAX. In release mode it wraps to zero.

pub const fn value(self) -> u64

Returns the underlying value of the PowerOfTwo64.

pub const fn as_usize(self) -> usize

Returns the underlying value as usize.

Panics

Panics if usize is smaller than u32.

Trait Implementations

impl Clone for PowerOfTwo64

fn clone(&self) -> PowerOfTwo64

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PowerOfTwo64

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

Formats the value using the given formatter.

impl Display for PowerOfTwo64

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

Formats the value using the given formatter.

impl Hash for PowerOfTwo64

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 PartialEq for PowerOfTwo64

fn eq(&self, other: &PowerOfTwo64) -> 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 ReprC for PowerOfTwo64

const CHECK: () = ()

This field is used for const checks only.

impl Copy for PowerOfTwo64

impl Eq for PowerOfTwo64

impl StructuralPartialEq for PowerOfTwo64