Struct ChiselError 

pub struct ChiselError<F, S> {
    pub offset: usize,
    pub error: ChiselErrorData<F, S>,
}

The error type for chiseling operations.

This type provides offset information alongside the error data itself to allow for more precise diagnostics.

Kinds

This crate distinguishes between 3 ‘kinds’ of errors:

• EndOfInput: An unexpected end-of-input condition. If chiseling is retried with additional data provided in the input, it may succeed.
• Source: The Chisel’s source signalled an error condition.
• Format: The provided data to chisel is invalid in some way.

Fields

offset: usize

The byte offset that the error occurred at.

This is the offset of the beginning of the erroring operation or item.

error: ChiselErrorData<F, S>

The error data itself.

Implementations

impl<F, S> ChiselError<F, S>

pub fn new(offset: usize, error: ChiselErrorData<F, S>) -> Self

Creates a new Chisel Error with the provided offset and error data.

pub fn end_of_input(offset: usize) -> Self

Creates a new “unexpected end-of-input” Chisel Error with the provided offset.

pub fn source(offset: usize, error: S) -> Self

Creates a new Chisel Source Error with the provided offset and ‘underlying’ error.

pub fn format(offset: usize, error: F) -> Self

Creates a new Chisel Format Error with the provided offset and detail.

pub fn map<M: FnOnce(F) -> N, N>(self, mapper: M) -> ChiselError<N, S>

Maps a ChiselError<F, S> to ChiselError<N, S> by applying a function to the contained format error, if any.

This can be used to provide additional information about the issue with the provided data.

Note that both EndOfInput and Source errors are returned untouched.

impl<S> ChiselError<Infallible, S>

pub fn from_source(offset: usize, error: ChiselSourceError<S>) -> Self

Creates a ChiselError from a ChiselSourceError + an offset.

pub fn forward<F>(self) -> ChiselError<F, S>

Convert an InfallibleFormatError into an error with arbitrary format type.

(Note that because Infallible is uninhabited, this is always valid.)

This is basically a small hack to allow easy error propagation, as ChiselError<F, S> cannot implement From<ChiselError<Infallible, S>>.

Trait Implementations

impl<F: Debug, S: Debug> Debug for ChiselError<F, S>

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

Formats the value using the given formatter.

impl<F: Display, S: Display> Display for ChiselError<F, S>

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

Formats the value using the given formatter.

impl<F: Error + 'static, S: Error + 'static> Error for ChiselError<F, S>

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

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 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.