Struct ErrorReporter

Source
pub struct ErrorReporter;
Expand description

Utility for generating formatted error reports

Implementations§

Source§

impl ErrorReporter

Source

pub fn new() -> Self

Creates a new ErrorReporter instance

This is a simple constructor that returns a new instance of the ErrorReporter. Since ErrorReporter has no state, this is equivalent to using the Default implementation.

Source

pub fn report<W, E>( &self, error: &E, config: &ErrorReportConfig, writer: &mut W, ) -> Result<()>
where W: Write, E: Error,

Report an error to a writer using the provided configuration

Source

pub fn report_with_syntax<W, E>( &self, error: &E, config: &ErrorReportConfig, source_code: Option<&str>, writer: &mut W, ) -> Result<()>
where W: Write, E: Error,

Report an error with syntax highlighting and AST-aware formatting

This method provides enhanced error reporting with syntax highlighting, code snippets, and AST-aware formatting for better readability.

§Parameters
  • error - The error to report
  • config - Configuration for the error report
  • source_code - Optional source code context
  • writer - The writer to output the report to
§Returns

IO result indicating success or failure

Source

pub fn report_to_string<E>( &self, error: &E, config: &ErrorReportConfig, ) -> String
where E: Error,

Report an error as a string using the provided configuration

Source

pub fn report_to_string_with_syntax<E>( &self, error: &E, config: &ErrorReportConfig, source_code: Option<&str>, ) -> String
where E: Error,

Report an error as a string with syntax highlighting and AST-aware formatting

§Parameters
  • error - The error to report
  • config - Configuration for the error report
  • source_code - Optional source code context
§Returns

The formatted error report as a string

Trait Implementations§

Source§

impl Debug for ErrorReporter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ErrorReporter

Source§

fn default() -> ErrorReporter

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more