Struct AlignmentError

pub struct AlignmentError<Src, Dst: ?Sized> {
    src: Src,
    dst: SendSyncPhantomData<Dst>,
}

The error emitted if the conversion source is improperly aligned.

Fields

src: Src

The source value involved in the conversion.

dst: SendSyncPhantomData<Dst>

The inner destination type inolved in the conversion.

INVARIANT: An AlignmentError may only be constructed if Dst’s alignment requirement is greater than one.

Implementations

impl<Src, Dst: ?Sized> AlignmentError<Src, Dst>

pub(crate) unsafe fn new_unchecked(src: Src) -> Self

Safety

The caller must ensure that Dst’s alignment requirement is greater than one.

pub fn into_src(self) -> Src

Produces the source underlying the failed conversion.

pub(crate) fn with_src<NewSrc>( self, new_src: NewSrc, ) -> AlignmentError<NewSrc, Dst>

pub fn map_src<NewSrc>( self, f: impl FnOnce(Src) -> NewSrc, ) -> AlignmentError<NewSrc, Dst>

Maps the source value associated with the conversion error.

This can help mitigate issues with Send, Sync and 'static bounds.

Examples

use zerocopy::*;

let unaligned = Unalign::new(0u16);

// Attempt to deref `unaligned`. This might fail with an alignment error.
let maybe_n: Result<&u16, AlignmentError<&Unalign<u16>, u16>> = unaligned.try_deref();

// Map the error's source to its address as a usize.
let maybe_n: Result<&u16, AlignmentError<usize, u16>> = maybe_n.map_err(|err| {
    err.map_src(|src| src as *const _ as usize)
});

pub(crate) fn into<S, V>(self) -> ConvertError<Self, S, V>

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

where Src: Deref, Dst: KnownLayout,

Format extra details for a verbose, human-readable error message.

This formatting may include potentially sensitive information.

Trait Implementations

impl<Src, Dst: ?Sized> Debug for AlignmentError<Src, Dst>

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

Formats the value using the given formatter.

impl<Src, Dst> Display for AlignmentError<Src, Dst>

where Src: Deref, Dst: KnownLayout + ?Sized,

Produces a human-readable error message.

The message differs between debug and release builds. When debug_assertions are enabled, this message is verbose and includes potentially sensitive information.

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

Formats the value using the given formatter.

impl<Src, Dst> Error for AlignmentError<Src, Dst>

where Src: Deref, Dst: KnownLayout + ?Sized,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<Src, Dst: ?Sized, S, V> From<AlignmentError<Src, Dst>> for ConvertError<AlignmentError<Src, Dst>, S, V>

fn from(err: AlignmentError<Src, Dst>) -> Self

Converts to this type from the input type.

impl<Src, Dst: ?Sized + Unaligned> From<AlignmentError<Src, Dst>> for Infallible

fn from(_: AlignmentError<Src, Dst>) -> Infallible

Converts to this type from the input type.

impl<Src: PartialEq, Dst: PartialEq + ?Sized> PartialEq for AlignmentError<Src, Dst>

fn eq(&self, other: &AlignmentError<Src, Dst>) -> 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<Src: Eq, Dst: Eq + ?Sized> Eq for AlignmentError<Src, Dst>

impl<Src, Dst: ?Sized> StructuralPartialEq for AlignmentError<Src, Dst>