Struct safe_transmute::error::GuardError

pub struct GuardError {
    pub required: usize,
    pub actual: usize,
    pub reason: ErrorReason,
}

A slice boundary guard error, usually created by a Guard.

Examples

assert_eq!(
    SingleManyGuard::check::<u16>(&[0x00]),
    Err(GuardError {
        required: 16 / 8,
        actual: 1,
        reason: ErrorReason::NotEnoughBytes,
    })
);

Fields

required: usize

The required amount of bytes for transmutation.

actual: usize

The actual amount of bytes.

reason: ErrorReason

Why this required/actual/T combo is an error.

Trait Implementations

impl Clone for GuardError

fn clone(&self) -> GuardError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GuardError

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

Formats the value using the given formatter.

impl Display for GuardError

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

Formats the value using the given formatter.

impl Error for GuardError

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 Hash for GuardError

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 PartialEq<GuardError> for GuardError

fn eq(&self, other: &GuardError) -> bool

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

fn ne(&self, other: &GuardError) -> bool

This method tests for !=.

impl Copy for GuardError

impl Eq for GuardError

impl StructuralEq for GuardError

impl StructuralPartialEq for GuardError