Struct MemoryLayout 

pub struct MemoryLayout { /* private fields */ }

Memory layout representation: alignment and size aligned for this alignment

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

Implementations

impl MemoryLayout

pub fn new<T>(size: T, alignment: AllocAlignment) -> Result<Self, ZLayoutError>

where T: TryInto<NonZeroUsize>,

Try to create a new memory layout.

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 zero size have passed or if the provided size is not the multiply of the alignment.

pub const fn for_type<T: Sized>() -> Self

Creates a new MemoryLayout for 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_value<T: Sized>(_: &T) -> Self

Creates a new MemoryLayout for value type.

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

pub fn size(&self) -> NonZeroUsize

pub fn alignment(&self) -> AllocAlignment

pub fn extend( &self, new_alignment: AllocAlignment, ) -> Result<MemoryLayout, ZLayoutError>

Realign the layout for new alignment. The alignment must be >= of the existing one.

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

# Examples

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

// 8 bytes with 4-byte alignment
let layout4b = MemoryLayout::new(8, AllocAlignment::new(2).unwrap()).unwrap();

// Try to realign with 2-byte alignment
let layout2b = layout4b.extend(AllocAlignment::new(1).unwrap());
assert!(layout2b.is_err()); // fails because new alignment must be >= old

// Try to realign with 8-byte alignment
let layout8b = layout4b.extend(AllocAlignment::new(3).unwrap());
assert!(layout8b.is_ok()); // ok

Trait Implementations

impl Clone for MemoryLayout

fn clone(&self) -> MemoryLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryLayout

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

Formats the value using the given formatter.

impl Display for MemoryLayout

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

Formats the value using the given formatter.

impl From<&MemoryLayout> for MemoryLayout

fn from(other: &MemoryLayout) -> Self

Converts to this type from the input type.

impl PartialEq for MemoryLayout

fn eq(&self, other: &MemoryLayout) -> 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 TryFrom<(NonZero<usize>, AllocAlignment)> for MemoryLayout

type Error = ZLayoutError

The type returned in the event of a conversion error.

fn try_from(value: (NonZeroUsize, AllocAlignment)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(usize, AllocAlignment)> for MemoryLayout

type Error = ZLayoutError

The type returned in the event of a conversion error.

fn try_from(value: (usize, AllocAlignment)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NonZero<usize>> for MemoryLayout

type Error = ZLayoutError

The type returned in the event of a conversion error.

fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for MemoryLayout

type Error = ZLayoutError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MemoryLayout

impl Eq for MemoryLayout

impl StructuralPartialEq for MemoryLayout