Struct tectonic::errors::Error

pub struct Error(pub ErrorKind, _);

The Error type.

This tuple struct is made of two elements:

• an ErrorKind which is used to determine the type of the error.
• An internal State, not meant for direct use outside of error_chain internals, containing:
  • a backtrace, generated when the error is created.
  • an error chain, used for the implementation of Error::cause().

Methods

impl Error

pub fn from_kind(kind: ErrorKind) -> Error

Constructs an error from a kind, and generates a backtrace.

pub fn with_chain<E, K>(error: E, kind: K) -> Error where     E: Error + Send + 'static,     K: Into<ErrorKind>,

Constructs a chained error from another error and a kind, and generates a backtrace.

pub fn with_boxed_chain<K>(error: Box<Error + Send>, kind: K) -> Error where     K: Into<ErrorKind>,

Construct a chained error from another boxed error and a kind, and generates a backtrace

pub fn kind(&self) -> &ErrorKind

Returns the kind of the error.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = &'a (Error + 'a);

pub fn iter(&self) -> Iter

Iterates over the error chain.

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

Returns the backtrace associated with this error.

pub fn chain_err<F, EK>(self, error: F) -> Error where     F: FnOnce() -> EK,     EK: Into<ErrorKind>,

Extends the error chain with a new entry.

impl Error

pub fn dump_uncolorized(&self)

Write the information contained in this object to standard error in a somewhat user-friendly form.

The error_chain crate provides a Display impl for its Error objects that ought to provide this functionality, but I have had enormous trouble being able to use it. So instead we emulate their code. This function is also paralleled by the implementation in status::termcolor::TermcolorStatusBackend, which adds the sugar of providing nice colorization if possible. This function should only be used if a StatusBackend is not yet available in the running program.

Methods from Deref<Target = ErrorKind>

pub fn description(&self) -> &str

A string describing the error kind.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl ChainedError for Error

type ErrorKind = ErrorKind

Associated kind type.

fn new(kind: ErrorKind, state: State) -> Error

fn from_kind(kind: Self::ErrorKind) -> Self

Constructs an error from a kind, and generates a backtrace.

fn with_chain<E, K>(error: E, kind: K) -> Self where     E: Error + Send + 'static,     K: Into<Self::ErrorKind>,

Constructs a chained error from another error and a kind, and generates a backtrace.

fn kind(&self) -> &Self::ErrorKind

Returns the kind of the error.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = &'a (Error + 'a);

fn iter(&self) -> Iter

Iterates over the error chain.

fn chain_err<F, EK>(self, error: F) -> Self where     F: FnOnce() -> EK,     EK: Into<ErrorKind>,

Extends the error chain with a new entry.

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

Returns the backtrace associated with this error.

fn extract_backtrace(e: &(Error + Send + 'static)) -> Option<Arc<Backtrace>>

fn display_chain(&'a self) -> DisplayChain<'a, Self>

Returns an object which implements Display for printing the full context of this error.

impl Error for Error

fn description(&self) -> &str

This method is soft-deprecated.

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

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

impl Display for Error

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

Formats the value using the given formatter.

impl From<AppDirsError> for Error

fn from(e: AppDirsError) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<NulError> for Error

fn from(e: NulError) -> Self

Performs the conversion.

impl From<ParseIntError> for Error

fn from(e: ParseIntError) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

fn from(e: Utf8Error) -> Self

Performs the conversion.

impl From<XdvError> for Error

fn from(e: XdvError) -> Self

Performs the conversion.

impl From<ZipError> for Error

fn from(e: ZipError) -> Self

Performs the conversion.

impl From<ErrorKind> for Error

fn from(e: ErrorKind) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Error

fn from(s: &'a str) -> Self

Performs the conversion.

impl From<String> for Error

fn from(s: String) -> Self

Performs the conversion.

impl Deref for Error

type Target = ErrorKind

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Error> for ErrorKind

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Error

Performs the conversion.

impl DefinitelySame for Error

fn definitely_same(&self, other: &Self) -> bool

Here we abuse DefinitelySame a bit and ignore the backtrace etc.