Enum safe_transmute::error::Error

pub enum Error<'a, S, T> {
    Guard(GuardError),
    Unaligned(UnalignedError<'a, S, T>),
    IncompatibleVecTarget(IncompatibleVecTargetError<S, T>),
    InvalidValue,
}

A transmutation error. This type describes possible errors originating from operations in this crate. The two type parameters represent the source element type and the target element type respectively.

Examples

assert_eq!(transmute_bool_pedantic(&[0x05]), Err(Error::InvalidValue));

Variants

Guard(GuardError)

The data does not respect the target type’s boundaries.

Unaligned(UnalignedError<'a, S, T>)

The given data slice is not properly aligned for the target type.

IncompatibleVecTarget(IncompatibleVecTargetError<S, T>)

The data vector’s element type does not have the same size and minimum alignment as the target type.

Does not exist without the alloc feature.

InvalidValue

The data contains an invalid value for the target type.

Implementations

impl<'a, S, T> Error<'a, S, T>

pub fn copy(self) -> Result<Vec<T>, Error<'a, S, T>> where
    T: TriviallyTransmutable, 

Reattempt the failed transmutation if the failure was caused by either an unaligned memory access, or an incompatible vector element target.

Otherwise return self.

pub unsafe fn copy_unchecked(self) -> Result<Vec<T>, Error<'a, S, T>>

Reattempt the failed non-trivial transmutation if the failure was caused by either an unaligned memory access, or an incompatible vector element target.

Otherwise return self.

Safety

The source data needs to correspond to a valid contiguous sequence of T values.

pub fn without_src<'z>(self) -> Error<'z, S, T>

Create a new error which discards runtime information about the source data, by making it point to an empty slice. This makes the error value live longer than the context of transmutation.

Trait Implementations

impl<'a, S: Clone, T: Clone> Clone for Error<'a, S, T>

fn clone(&self) -> Error<'a, S, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S, T> Debug for Error<'a, S, T>

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

Formats the value using the given formatter.

impl<'a, S, T> Display for Error<'a, S, T>

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

Formats the value using the given formatter.

impl<'a, S, T> Error for Error<'a, S, T>

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<'a, S, T> From<GuardError> for Error<'a, S, T>

fn from(o: GuardError) -> Self

Performs the conversion.

impl<'a, S, T> From<IncompatibleVecTargetError<S, T>> for Error<'a, S, T>

fn from(e: IncompatibleVecTargetError<S, T>) -> Self

Performs the conversion.

impl<'a, S, T> From<UnalignedError<'a, S, T>> for Error<'a, S, T>

fn from(o: UnalignedError<'a, S, T>) -> Self

Performs the conversion.

impl<'a, S: Hash, T: Hash> Hash for Error<'a, S, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, S: PartialEq, T: PartialEq> PartialEq<Error<'a, S, T>> for Error<'a, S, T>

fn eq(&self, other: &Error<'a, S, T>) -> bool

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

fn ne(&self, other: &Error<'a, S, T>) -> bool

This method tests for !=.

impl<'a, S: Eq, T: Eq> Eq for Error<'a, S, T>

impl<'a, S, T> StructuralEq for Error<'a, S, T>

impl<'a, S, T> StructuralPartialEq for Error<'a, S, T>