Struct s2n_codec::zerocopy::Unalign

pub struct Unalign<T>(_);

A type with no alignment requirement.

A Unalign wraps a T, removing any alignment requirement. Unalign<T> has the same size and ABI as T, but not necessarily the same alignment. This is useful if a type with an alignment requirement needs to be read from a chunk of memory which provides no alignment guarantees.

Since Unalign has no alignment requirement, the inner T may not be properly aligned in memory, and so Unalign provides no way of getting a reference to the inner T. Instead, the T may only be obtained by value (see get and into_inner).

Implementations

impl<T> Unalign<T>

pub fn new(val: T) -> Unalign<T>

Constructs a new Unalign.

pub fn into_inner(self) -> T

Consumes self, returning the inner T.

pub fn get_ptr(&self) -> *const T

Gets an unaligned raw pointer to the inner T.

Safety

The returned raw pointer is not necessarily aligned to align_of::<T>(). Most functions which operate on raw pointers require those pointers to be aligned, so calling those functions with the result of get_ptr will be undefined behavior if alignment is not guaranteed using some out-of-band mechanism. In general, the only functions which are safe to call with this pointer are which that are explicitly documented as being sound to use with an unaligned pointer, such as read_unaligned.

pub fn get_mut_ptr(&mut self) -> *mut T

Gets an unaligned mutable raw pointer to the inner T.

Safety

The returned raw pointer is not necessarily aligned to align_of::<T>(). Most functions which operate on raw pointers require those pointers to be aligned, so calling those functions with the result of get_ptr will be undefined behavior if alignment is not guaranteed using some out-of-band mechanism. In general, the only functions which are safe to call with this pointer are those which are explicitly documented as being sound to use with an unaligned pointer, such as read_unaligned.

impl<T> Unalign<T>where T: Copy,

pub fn get(&self) -> T

Gets a copy of the inner T.

Trait Implementations

impl<T> AsBytes for Unalign<T>where T: AsBytes,

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn write_to<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to bytes.

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes.

impl<T> Clone for Unalign<T>where T: Copy,

fn clone(&self) -> Unalign<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> FromBytes for Unalign<T>where T: FromBytes,

fn read_from<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<T> Copy for Unalign<T>where T: Copy,

impl<T> Unaligned for Unalign<T>