Struct PowerOfTwo

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

Represents an integral power-of-two as an exponent.

Implementations

impl PowerOfTwo

pub fn exp<R>(self) -> R

where R: From<u32>,

Returns the base-2 exponent as a numeric type

pub fn floor<F: Into<u32>>(f: F) -> PowerOfTwo

Converts a number two the nearest PowerOfTwo less-than-or-equal to it.

pub fn ceiling<F: Into<u32>>(f: F) -> PowerOfTwo

Converts a number two the nearest PowerOfTwo greater-than-or-equal to it.

pub fn zero() -> PowerOfTwo

Creates a new PowerOfTwo representing the number zero.

pub fn as_num<F: From<u32>>(self) -> F

Converts a PowerOfTwo to a number.

Trait Implementations

impl Clone for PowerOfTwo

fn clone(&self) -> PowerOfTwo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PowerOfTwo

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

Formats the value using the given formatter.

impl Ord for PowerOfTwo

fn cmp(&self, other: &PowerOfTwo) -> 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 PowerOfTwo

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

fn partial_cmp(&self, other: &PowerOfTwo) -> 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 PowerOfTwo

impl Eq for PowerOfTwo

impl StructuralPartialEq for PowerOfTwo