Struct swim_mem::block::Layout

pub struct Layout { /* fields omitted */ }

Size and alignment constraints for a memory block.

Methods

impl Layout

pub const fn empty() -> Layout

Returns a zero-sized Layout with byte alignment.

pub const unsafe fn from_size_align_unchecked(
    size: usize,
    align: usize
) -> Layout

Returns a Layout with the given size and power-of-two alignment.

pub fn from_size_align(size: usize, align: usize) -> Result<Layout, LayoutError>

Returns a Layout with the given size and power-of-two alignment, or None for invalid constraints.

pub fn for_type<T>() -> Layout

Returns the Layout of the parameterized type.

pub fn for_value<T: ?Sized>(value: &T) -> Layout

Returns the Layout of the given value.

pub fn for_array<T>(len: usize) -> Result<Layout, LayoutError>

Returns the Layout of an array of len values of the parameterized type.

pub unsafe fn for_array_unchecked<T>(len: usize) -> Layout

pub const fn size(&self) -> usize

Returns the required size in bytes of a valid memory block.

pub fn align(&self) -> usize

Returns the required power-of-two base address alignment for a valid memory block.

pub fn aligned_to(&self, align: usize) -> Layout

Returns this layout with at least align byte alignment.

pub fn aligned_to_type<T>(&self) -> Layout

Returns this layout with at least the alignment of the parameterized type.

pub fn aligned_to_value<T: ?Sized>(&self, value: &T) -> Layout

Returns this layout with at least the alignment of the given value.

pub fn padded_to(&self, align: usize) -> Layout

Returns this layout with its size rounded up to the given alignment.

pub fn padded_to_type<T>(&self) -> Layout

Returns this layout with its size rouneded up to the alignment of a subsequent field of the given type.

pub fn padded_to_value<T: ?Sized>(&self, value: &T) -> Layout

Returns this layout with its size rounded up to the the alignment of alignment of the given field.

pub fn extended(&self, that: Layout) -> Result<(Layout, usize), LayoutError>

Returns the Layout of a struct with this layout as its first member, and that layout as its second member.

pub fn extended_by_type<T>(&self) -> Result<(Layout, usize), LayoutError>

pub fn extended_by_value<T: ?Sized>(
    &self,
    value: &T
) -> Result<(Layout, usize), LayoutError>

pub fn extended_by_array<T>(
    &self,
    len: usize
) -> Result<(Layout, usize), LayoutError>

pub unsafe fn extended_unchecked(&self, that: Layout) -> (Layout, usize)

Returns the Layout of a struct with this layout as its first member, and that layout as its second member, without checking for size overflow.

pub unsafe fn extended_by_type_unchecked<T>(&self) -> (Layout, usize)

pub unsafe fn extended_by_value_unchecked<T: ?Sized>(
    &self,
    value: &T
) -> (Layout, usize)

pub unsafe fn extended_by_array_unchecked<T>(
    &self,
    len: usize
) -> (Layout, usize)

pub fn repeated(&self, len: usize) -> Result<(Layout, usize), LayoutError>

Returns the Layout of an array with len elements of this layout.

pub unsafe fn repeated_unchecked(&self, len: usize) -> (Layout, usize)

Returns the Layout of an array with len elements of this layout, without checking for size overflow.

Trait Implementations

impl PartialEq<Layout> for Layout

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

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

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

This method tests for !=.

impl Eq for Layout

impl Debug for Layout

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

Formats the value using the given formatter.

impl Copy for Layout

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.