Struct ValidityError 

pub struct ValidityError<Src, Dst: ?Sized + TryFromBytes> {
    pub(crate) src: Src,
    dst: SendSyncPhantomData<Dst>,
}

The error emitted if the conversion source contains invalid data.

Fields

src: Src

The source value involved in the conversion.

dst: SendSyncPhantomData<Dst>

The inner destination type inolved in the conversion.

Implementations

impl<Src, Dst: ?Sized + TryFromBytes> ValidityError<Src, Dst>

pub(crate) fn new(src: Src) -> Self

pub fn into_src(self) -> Src

Produces the source underlying the failed conversion.

pub fn map_src<NewSrc>( self, f: impl FnOnce(Src) -> NewSrc, ) -> ValidityError<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 source: u8 = 42;

// Try to transmute the `source` to a `bool`. This will fail.
let maybe_bool: Result<bool, ValidityError<u8, bool>> = try_transmute!(source);

// Drop the error's source.
let maybe_bool: Result<bool, ValidityError<(), bool>> = maybe_bool.map_err(|err| {
    err.map_src(drop)
});

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

Converts the error into a general ConvertError.

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

where 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 + TryFromBytes> Debug for ValidityError<Src, Dst>

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

Formats the value using the given formatter.

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

where Dst: KnownLayout + TryFromBytes + ?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: Eq, Dst: Eq + ?Sized + TryFromBytes> Eq for ValidityError<Src, Dst>

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

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

where Dst: KnownLayout + TryFromBytes + ?Sized,

Available on rust="1.81.0" and crate feature std only.

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

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

#[doc(hidden)] fn type_id(&self, _: Internal) -> TypeId

where Self: 'static,

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

Gets the TypeId of self.

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 + TryFromBytes, A, S> From<ValidityError<Src, Dst>> for ConvertError<A, S, ValidityError<Src, Dst>>

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

Converts to this type from the input type.

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

fn eq(&self, other: &ValidityError<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, Dst: ?Sized + TryFromBytes> StructuralPartialEq for ValidityError<Src, Dst>