Struct Alignment 

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

Contains the alignment memory can have.

Example

use iceoryx2_bb_elementary::alignment::Alignment;

let my_alignment = Alignment::new(32).unwrap();

// zero is not a valid alignment
let broken_alignment = Alignment::new(0);
assert_eq!(broken_alignment, None);

// alignment must be a power of 2
let broken_alignment = Alignment::new(89);
assert_eq!(broken_alignment, None);

Implementations

impl Alignment

pub const ALIGN_1: Alignment

pub const ALIGN_2: Alignment

pub const ALIGN_4: Alignment

pub const ALIGN_8: Alignment

pub const ALIGN_16: Alignment

pub const ALIGN_32: Alignment

pub const ALIGN_64: Alignment

pub const ALIGN_128: Alignment

pub const ALIGN_256: Alignment

pub const ALIGN_512: Alignment

pub const ALIGN_1024: Alignment

pub const ALIGN_2048: Alignment

pub const ALIGN_4096: Alignment

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

Creates a new Alignment. If the value is zero or not a power of 2 it returns None.

pub const unsafe fn new_unchecked(value: usize) -> Self

Creates a new Alignment.

Safety

• The value must not be zero
• The value must be a power of 2

pub const fn value(&self) -> usize

Returns the value of the Alignment

Trait Implementations

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a duplicate 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 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 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 Copy for Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment