Struct AllocAlignment

pub struct AllocAlignment { /* private fields */ }

Available on crate feature unstable only.

alignment in powers of 2: 0 == 1-byte alignment, 1 == 2byte, 2 == 4byte, 3 == 8byte etc

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Implementations

impl AllocAlignment

pub const ALIGN_1_BYTE: AllocAlignment

pub const ALIGN_2_BYTES: AllocAlignment

pub const ALIGN_4_BYTES: AllocAlignment

pub const ALIGN_8_BYTES: AllocAlignment

pub const fn new(pow: u8) -> Result<AllocAlignment, ZLayoutError>

Try to create a new AllocAlignment from alignment representation in powers of 2.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Errors

This function will return an error if provided alignment power cannot fit into usize.

pub const fn for_val<T>(_: &T) -> AllocAlignment

Create a new AllocAlignment for value type

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub const fn for_type<T>() -> AllocAlignment

Create a new AllocAlignment for type

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn get_alignment_value(&self) -> NonZero<usize>

Get alignment in normal units (bytes)

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn align_size(&self, size: NonZero<usize>) -> NonZero<usize>

Align size according to inner alignment.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

This call may extend the size (see the example) # Examples

use zenoh_shm::api::provider::types::AllocAlignment;

let alignment = AllocAlignment::new(2).unwrap(); // 4-byte alignment
let initial_size = 7.try_into().unwrap();
let aligned_size = alignment.align_size(initial_size);
assert_eq!(aligned_size.get(), 8);

Trait Implementations

impl Clone for AllocAlignment

fn clone(&self) -> AllocAlignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllocAlignment

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

Formats the value using the given formatter.

impl Default for AllocAlignment

fn default() -> AllocAlignment

Returns the “default value” for a type.

impl Display for AllocAlignment

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

Formats the value using the given formatter.

impl Ord for AllocAlignment

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

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

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

impl Eq for AllocAlignment

impl StructuralPartialEq for AllocAlignment