Struct safe_transmute::error::UnalignedError

[+] Show declaration

pub struct UnalignedError<'a, S, T> {
    pub offset: usize,
    pub source: &'a [S],
    // some fields omitted
}

[−] Expand description

Unaligned memory access error.

Returned when the given data slice is not properly aligned for the target type. It would have been properly aligned if offset bytes were shifted (discarded) from the front of the slice.

Fields

offset: usize

[−] Expand description

The required amount of bytes to discard at the front for the attempted transmutation to be successful.

source: &'a [S]

[−] Expand description

A slice of the original source data.

Implementations

impl<'a, S, T> UnalignedError<'a, S, T>[−]

pub fn new(offset: usize, source: &'a [S]) -> Self

pub unsafe fn copy_unchecked(&self) -> Vec<T>[−]

Create a copy of the source data, transmuted into a vector. As the vector will be properly aligned for accessing values of type T, this operation will not fail due to memory alignment constraints.

Safety

The byte data in the slice needs to correspond to a valid contiguous sequence of T values.

pub fn copy(&self) -> Vec<T> where
    T: TriviallyTransmutable, [−]

Create a copy of the source data, transmuted into a vector. As T is trivially transmutable, and the vector will be properly allocated for accessing values of type T, this operation is safe and will never fail.

Trait Implementations

impl<'a, S: Clone, T: Clone> Clone for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> UnalignedError<'a, S, T>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<'a, S, T> Debug for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'a, S, T> Display for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

impl<'a, S, T> Error for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

fn description(&self) -> &str[−]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn source(&self) -> Option<&(dyn Error + 'static)>[−]

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

pub fn backtrace(&self) -> Option<&Backtrace>[−]

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

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

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl<'a, S: Hash, T: Hash> Hash for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

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

Feeds this value into the given Hasher.

pub 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<UnalignedError<'a, S, T>> for UnalignedError<'a, S, T>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &UnalignedError<'a, S, T>) -> bool[−]

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

fn ne(&self, other: &UnalignedError<'a, S, T>) -> bool[−]

This method tests for !=.

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

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