Struct Error 

pub struct Error {
    pub kind: ErrorKind,
    pub offset: Option<u64>,
    pub context: Context,
    pub reason: &'static str,
}

A failure visible to native and JavaScript callers: what went wrong, the absolute input offset and the structure it was found in, when known, and a fixed description.

Fields

kind: ErrorKind

offset: Option<u64>

Absolute byte offset in the input when known. For a Context::Pdf error it is in the whole input, not in an embedded PDF range.

context: Context

reason: &'static str

What was wrong or which field; empty when the kind says it all.

Implementations

impl Error

pub fn invalid(reason: &'static str) -> Self

An invalid caller-supplied range, count or option.

pub fn malformed(offset: u64, reason: &'static str) -> Self

A structure or field at offset the format does not allow.

pub fn unsupported(offset: u64, reason: &'static str) -> Self

A structure or field at offset outside the supported profile.

pub fn cancelled() -> Self

pub fn truncated(offset: u64, expected: u64, available: u64) -> Self

The source ended at offset with available of expected bytes.

pub fn limit(resource: &'static str, limit: u64, attempted: u64) -> Self

A configured resource bound would be exceeded.

pub fn at(self, offset: u64) -> Self

Set the absolute input offset.

pub fn because(self, reason: &'static str) -> Self

Set the description.

pub fn within(self, context: Context) -> Self

Set the structure the failure is located in.

pub fn in_caj(self, record: Option<u32>) -> Self

pub fn in_pdf(self, object: Option<(u32, u16)>) -> Self

pub fn in_jbig2(self, segment: Option<u32>) -> Self

pub fn or_at(self, offset: u64, context: Context) -> Self

Give an unlocated error this location; a located one keeps its own.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

"{kind} {context} at byte {offset}, {location}: {reason}: {details}" with the pieces present.

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

Formats the value using the given formatter.

impl Error for Error

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

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

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 From<&Error> for ApplicationInfoDefect

A malformed package names its field before the first ": " of the reason; any other failure names the field or resource it concerns.

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

An I/O error that carries a core error, as an io::Write adapter in this crate reports one, converts back to that error.

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Carry a core error through an io::Write adapter; an unlocated I/O error is passed on as it is, and a located one keeps its I/O kind.

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.