Struct encase::internal::AlignmentValue

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

Helper type for alignment calculations

Implementations

impl AlignmentValue

pub const fn new(val: u64) -> Self

pub const fn from_next_power_of_two_size(size: SizeValue) -> Self

Returns an alignment that is the smallest power of two greater than the passed in size

pub const fn get(&self) -> u64

pub const fn max<const N: usize>(input: [AlignmentValue; N]) -> AlignmentValue

Returns the max alignment from an array of alignments

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

Returns true if n is a multiple of this alignment

pub const fn padding_needed_for(&self, n: u64) -> u64

Returns the amount of padding needed so that n + padding will be a multiple of this alignment

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

Will round up the given n so that the returned value will be a multiple of this alignment

pub const fn round_up_size(&self, n: SizeValue) -> SizeValue

Will round up the given n so that the returned value will be a multiple of this alignment

Trait Implementations

impl Clone for AlignmentValue

fn clone(&self) -> AlignmentValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlignmentValue

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

Formats the value using the given formatter.

impl PartialEq for AlignmentValue

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AlignmentValue

impl Eq for AlignmentValue

impl StructuralPartialEq for AlignmentValue