Struct Alignment

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

A newtype struct where its only valid values are powers of 2

Implementations

impl Alignment

pub const ONE: Self = _

pub const TWO: Self = _

pub const FOUR: Self = _

pub const EIGHT: Self = _

pub const SIXTEEN: Self = _

pub const MIN_UNIFORM: Self = Self::SIXTEEN

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

pub fn from_width(width: u8) -> Self

Panics

If width is not a power of 2

pub const fn is_aligned(&self, n: u32) -> bool

Returns whether or not n is a multiple of this alignment.

pub const fn round_up(&self, n: u32) -> u32

Round n up to the nearest alignment boundary.

Trait Implementations

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Alignment

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

Formats the value using the given formatter.

impl Display for Alignment

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

Formats the value using the given formatter.

impl From<VectorSize> for Alignment

fn from(size: VectorSize) -> Self

Converts to this type from the input type.

impl Hash for Alignment

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 Mul<u32> for Alignment

type Output = u32

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Mul for Alignment

type Output = Alignment

The resulting type after applying the * operator.

fn mul(self, rhs: Alignment) -> Self::Output

Performs the * operation.

impl Ord for Alignment

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

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

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

impl Eq for Alignment

impl StructuralPartialEq for Alignment