Struct GenericBlockSize 

pub struct GenericBlockSize<T: BlockSizeSpec>(/* private fields */);

Represents a block size that is a power of 2, parameterized by a BlockSizeSpec.

Provides zero-cost bitwise operations for alignments, conversions, and arithmetic with integers.

Implementations

impl<T: BlockSizeSpec> GenericBlockSize<T>

pub fn from_spec(spec: T) -> Self

pub fn get(self) -> u64

Returns the block size in bytes.

pub fn mask(self) -> u64

Returns the alignment mask (size - 1).

pub fn shift(self) -> u32

Returns the power-of-two bit shift (e.g. 12 for 4096-byte blocks).

pub fn is_aligned(self, value: impl IsAligned<T>) -> bool

Returns true if value is aligned to this block size.

pub fn align_up(self, bytes: u64) -> Option<u64>

Aligns bytes up to the nearest block boundary, returning None on overflow.

pub fn align_down(self, bytes: u64) -> u64

Aligns bytes down to the nearest block boundary.

pub fn align_up_to_blocks(self, bytes: u64) -> u64

Aligns bytes up to the nearest block boundary and returns the total number of blocks.

pub fn align_range_outwards( self, range: impl Borrow<Range<u64>>, ) -> Option<Range<u64>>

Aligns the range outwards to block boundaries (start aligned down, end aligned up).

Returns None if aligning end overflows u64.

impl GenericBlockSize<MaskShiftSpec>

pub const SIZE_512B: Self

pub const SIZE_1KIB: Self

pub const SIZE_2KIB: Self

pub const SIZE_4KIB: Self

pub const SIZE_8KIB: Self

pub const SIZE_16KIB: Self

pub const SIZE_32KIB: Self

pub const SIZE_64KIB: Self

pub const SIZE_128KIB: Self

pub const SIZE_256KIB: Self

pub const SIZE_512KIB: Self

pub const SIZE_1MIB: Self

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

Constructs a BlockSize from a u32 byte count if it is a power of 2 and not equal to 0.

pub const fn from_u64(block_size: u64) -> Option<Self>

Constructs a BlockSize from a u64 if it is a power of 2, not equal to 0, and the mask fits in a u32. This is equivalent to Self::new but allows for constructing a 4GiB block size.

pub const fn size(self) -> u64

Returns the block size in bytes.

Equivalent to Self::get but can be called from a const context.

Trait Implementations

impl<T: BlockSizeSpec> Add<&GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: &GenericBlockSize<T>) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<&GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: &GenericBlockSize<T>) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<&u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: &u64) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<&u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: &u64) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: GenericBlockSize<T>) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: GenericBlockSize<T>) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: u64) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> Add<u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the + operator.

fn add(self, other: u64) -> u64

Performs the + operation.

impl<T: BlockSizeSpec> AddAssign<&GenericBlockSize<T>> for u64

fn add_assign(&mut self, other: &GenericBlockSize<T>)

Performs the += operation.

impl<T: BlockSizeSpec> AddAssign<GenericBlockSize<T>> for u64

fn add_assign(&mut self, other: GenericBlockSize<T>)

Performs the += operation.

impl<T: BlockSizeSpec> Binary for GenericBlockSize<T>

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

Formats the value using the given formatter.

impl<T: Clone + BlockSizeSpec> Clone for GenericBlockSize<T>

fn clone(&self) -> GenericBlockSize<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + BlockSizeSpec> Copy for GenericBlockSize<T>

impl<T: Debug + BlockSizeSpec> Debug for GenericBlockSize<T>

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

Formats the value using the given formatter.

impl<T: BlockSizeSpec> Display for GenericBlockSize<T>

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

Formats the value using the given formatter.

impl<T: BlockSizeSpec> Div<&GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the / operator.

fn div(self, other: &GenericBlockSize<T>) -> u64

Performs the / operation.

impl<T: BlockSizeSpec> Div<&GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the / operator.

fn div(self, other: &GenericBlockSize<T>) -> u64

Performs the / operation.

impl<T: BlockSizeSpec> Div<GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the / operator.

fn div(self, other: GenericBlockSize<T>) -> u64

Performs the / operation.

impl<T: BlockSizeSpec> Div<GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the / operator.

fn div(self, other: GenericBlockSize<T>) -> u64

Performs the / operation.

impl<T: BlockSizeSpec> DivAssign<&GenericBlockSize<T>> for u64

fn div_assign(&mut self, other: &GenericBlockSize<T>)

Performs the /= operation.

impl<T: BlockSizeSpec> DivAssign<GenericBlockSize<T>> for u64

fn div_assign(&mut self, other: GenericBlockSize<T>)

Performs the /= operation.

impl<T: Eq + BlockSizeSpec> Eq for GenericBlockSize<T>

impl From<GenericBlockSize<PageSizeSpec>> for BlockSize

fn from(_value: GenericBlockSize<PageSizeSpec>) -> Self

Converts to this type from the input type.

impl<T: BlockSizeSpec> Hash for GenericBlockSize<T>

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<T: BlockSizeSpec> LowerHex for GenericBlockSize<T>

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

Formats the value using the given formatter.

impl<T: BlockSizeSpec> Mul<&GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: &GenericBlockSize<T>) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<&GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: &GenericBlockSize<T>) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<&u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: &u64) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<&u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: &u64) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: GenericBlockSize<T>) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: GenericBlockSize<T>) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: u64) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> Mul<u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the * operator.

fn mul(self, other: u64) -> u64

Performs the * operation.

impl<T: BlockSizeSpec> MulAssign<&GenericBlockSize<T>> for u64

fn mul_assign(&mut self, other: &GenericBlockSize<T>)

Performs the *= operation.

impl<T: BlockSizeSpec> MulAssign<GenericBlockSize<T>> for u64

fn mul_assign(&mut self, other: GenericBlockSize<T>)

Performs the *= operation.

impl<T: BlockSizeSpec> Octal for GenericBlockSize<T>

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

Formats the value using the given formatter.

impl<T: BlockSizeSpec> Ord for GenericBlockSize<T>

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: BlockSizeSpec> PartialEq<&GenericBlockSize<T>> for u64

fn eq(&self, other: &&GenericBlockSize<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialEq<&u64> for GenericBlockSize<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialEq<GenericBlockSize<T>> for u64

fn eq(&self, other: &GenericBlockSize<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialEq<GenericBlockSize<T>> for &u64

fn eq(&self, other: &GenericBlockSize<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec, U: BlockSizeSpec> PartialEq<GenericBlockSize<T>> for GenericBlockSize<U>

fn eq(&self, other: &GenericBlockSize<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialEq<u64> for GenericBlockSize<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialEq<u64> for &GenericBlockSize<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: BlockSizeSpec> PartialOrd<&GenericBlockSize<T>> for u64

fn partial_cmp(&self, other: &&GenericBlockSize<T>) -> 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<T: BlockSizeSpec> PartialOrd<&u64> for GenericBlockSize<T>

fn partial_cmp(&self, other: &&u64) -> 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<T: BlockSizeSpec> PartialOrd<GenericBlockSize<T>> for u64

fn partial_cmp(&self, other: &GenericBlockSize<T>) -> 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<T: BlockSizeSpec> PartialOrd<GenericBlockSize<T>> for &u64

fn partial_cmp(&self, other: &GenericBlockSize<T>) -> 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<T: BlockSizeSpec, U: BlockSizeSpec> PartialOrd<GenericBlockSize<T>> for GenericBlockSize<U>

fn partial_cmp(&self, other: &GenericBlockSize<T>) -> 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<T: BlockSizeSpec> PartialOrd<u64> for GenericBlockSize<T>

fn partial_cmp(&self, other: &u64) -> 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<T: BlockSizeSpec> PartialOrd<u64> for &GenericBlockSize<T>

fn partial_cmp(&self, other: &u64) -> 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<T: BlockSizeSpec> Rem<&GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the % operator.

fn rem(self, other: &GenericBlockSize<T>) -> u64

Performs the % operation.

impl<T: BlockSizeSpec> Rem<&GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the % operator.

fn rem(self, other: &GenericBlockSize<T>) -> u64

Performs the % operation.

impl<T: BlockSizeSpec> Rem<GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the % operator.

fn rem(self, other: GenericBlockSize<T>) -> u64

Performs the % operation.

impl<T: BlockSizeSpec> Rem<GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the % operator.

fn rem(self, other: GenericBlockSize<T>) -> u64

Performs the % operation.

impl<T: BlockSizeSpec> RemAssign<&GenericBlockSize<T>> for u64

fn rem_assign(&mut self, other: &GenericBlockSize<T>)

Performs the %= operation.

impl<T: BlockSizeSpec> RemAssign<GenericBlockSize<T>> for u64

fn rem_assign(&mut self, other: GenericBlockSize<T>)

Performs the %= operation.

impl<T: BlockSizeSpec> Sub<&GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: &GenericBlockSize<T>) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<&GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: &GenericBlockSize<T>) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<&u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: &u64) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<&u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: &u64) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<GenericBlockSize<T>> for u64

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: GenericBlockSize<T>) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<GenericBlockSize<T>> for &u64

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: GenericBlockSize<T>) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<u64> for GenericBlockSize<T>

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: u64) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> Sub<u64> for &GenericBlockSize<T>

type Output = u64

The resulting type after applying the - operator.

fn sub(self, other: u64) -> u64

Performs the - operation.

impl<T: BlockSizeSpec> SubAssign<&GenericBlockSize<T>> for u64

fn sub_assign(&mut self, other: &GenericBlockSize<T>)

Performs the -= operation.

impl<T: BlockSizeSpec> SubAssign<GenericBlockSize<T>> for u64

fn sub_assign(&mut self, other: GenericBlockSize<T>)

Performs the -= operation.

impl<T: BlockSizeSpec> UpperHex for GenericBlockSize<T>

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

Formats the value using the given formatter.