Enum pelite::Error

pub enum Error {
    Null,
    Bounds,
    ZeroFill,
    Unmapped,
    Misaligned,
    BadMagic,
    PeMagic,
    Insanity,
    Invalid,
    Overflow,
    Encoding,
}

Errors while parsing the PE binary.

Variants

Null

Null address.

Bounds

Out of bounds.

Catch-all for bounds check errors.

ZeroFill

Data is not available.

Can happen when referencing data in PeFile instances.

Sections can be shorter than stored on disk, the remaining bytes will default to zeroes when loaded by the system. Since these zeroes would just be a waste of space, they are not present in the binaries on disk. This error happens when attempting to get a reference to such zero filled data.

Unmapped

Data is not available.

Can happen when referencing data in PeView instances.

Sections can have excess in their raw data which won't be mapped when loaded by the system. This error happens when attempting to get a reference to such unmapped raw data. Sometimes this kind of excess is called an overlay.

Misaligned

Address is misaligned.

BadMagic

Expected magic number does not match.

PeMagic

Trying to load a PE32 file with a PE32+ parser or vice versa.

Insanity

Sanity check failed.

Some value was so far outside its typical range, while not technically incorrect, probably indicating something went wrong. If this error is encountered legitimately, create an issue or file a PR to relax the artificial restrictions.

Invalid

Invalid data.

Structured data was found which simply isn't valid. Catch-all for errors which don't fall under other errors.

Overflow

Overflow error.

Catch-all for overflow and underflow errors.

Encoding

Encoding error.

Catch-all for string related errors such as lacking a nul terminator.

Methods

impl Error

pub fn is_null(self) -> bool

Returns if the error variant is Null.

Useful in match guards where Null should be handled as a non-error case.

fn with_default(result: pelite::Result<i32>) -> pelite::Result<i32> {
	let i = match result {
		Ok(i) => i,
		// Avoids a more verbose comparison with pelite::Error::Null
		Err(err) if err.is_null() => 0,
		Err(err) => return Err(err),
	};
	Ok(i)
}

assert_eq!(with_default(Err(pelite::Error::Null)), Ok(0));

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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 From<Error> for FindError

fn from(err: Error) -> FindError

Performs the conversion.

impl Hash for Error

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<Error> for Error

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Error

impl StructuralPartialEq for Error