Struct AlignedOffset 

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

An unsigned offset that is maximally aligned.

Implementations

impl AlignedOffset

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

Try to construct an aligned offset.

pub fn get(self) -> usize

Get the wrapped offset as a usize.

pub fn next_up(self, bytes: usize) -> Option<Self>

Get the next valid offset after adding bytes to this.

use image_texel::layout::AlignedOffset;

let zero = AlignedOffset::default();

assert_eq!(zero.next_up(0), Some(zero));
assert_eq!(zero.next_up(1), zero.next_up(2));

assert!(zero.next_up(usize::MAX).is_none());
assert!(zero.next_up(isize::MAX as usize).is_none());

Trait Implementations

impl Clone for AlignedOffset

fn clone(&self) -> AlignedOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AlignedOffset

impl Debug for AlignedOffset

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

Formats the value using the given formatter.

impl Default for AlignedOffset

fn default() -> AlignedOffset

Returns the “default value” for a type.

impl Eq for AlignedOffset

impl Ord for AlignedOffset

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

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

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