Struct swc_common::errors::Handler

source ·
pub struct Handler {
    pub flags: HandlerFlags,
    /* private fields */
}
Expand description

A handler deals with errors; certain errors (fatal, bug, unimpl) may cause immediate exit, others log errors for later reporting.

§Example

swc provides a global-like variable (HANDLER) of type Handler that can be used to report errors.

You can refer to the lint rules for other example usages. All lint rules have code for error reporting.

§Error reporting in swc

use swc_common::errors::HANDLER;

    HANDLER.with(|handler| {
        // You can access the handler for the current file using HANDLER.with.

        // We now report an error

        // `struct_span_err` creates a builder for a diagnostic.
        // The span passed to `struct_span_err` will used to point the problematic code.
        //
        // You may provide additional information, like a previous declaration of parameter.
        handler
            .struct_span_err(
                span,
                &format!("`{}` used as parameter more than once", js_word),
            )
            .span_note(
                old_span,
                &format!("previous definition of `{}` here", js_word),
            )
            .emit();
    });

Fields§

§flags: HandlerFlags

Implementations§

source§

impl Handler

source

pub fn with_tty_emitter( color_config: ColorConfig, can_emit_warnings: bool, treat_err_as_bug: bool, cm: Option<Lrc<SourceMapperDyn>> ) -> Handler

Available on crate feature tty-emitter only.
source

pub fn with_tty_emitter_and_flags( color_config: ColorConfig, cm: Option<Lrc<SourceMapperDyn>>, flags: HandlerFlags ) -> Handler

Available on crate feature tty-emitter only.
source

pub fn with_emitter( can_emit_warnings: bool, treat_err_as_bug: bool, emitter: Box<dyn Emitter> ) -> Handler

Example implementation of Emitter is EmitterWriter

source

pub fn with_emitter_writer( dst: Box<dyn Write + Send>, cm: Option<Lrc<SourceMapperDyn>> ) -> Handler

source

pub fn with_emitter_and_flags( e: Box<dyn Emitter>, flags: HandlerFlags ) -> Handler

source

pub fn set_continue_after_error(&self, continue_after_error: bool)

source

pub fn reset_err_count(&self)

Resets the diagnostic error count as well as the cached emitted diagnostics.

NOTE: DO NOT call this function from rustc. It is only meant to be called from external tools that want to reuse a Parser cleaning the previously emitted diagnostics as well as the overall count of emitted error diagnostics.

source

pub fn struct_dummy(&self) -> DiagnosticBuilder<'_>

source

pub fn struct_span_warn<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str ) -> DiagnosticBuilder<'a>

source

pub fn struct_span_warn_with_code<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str, code: DiagnosticId ) -> DiagnosticBuilder<'a>

source

pub fn struct_warn<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>

source

pub fn struct_span_err<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str ) -> DiagnosticBuilder<'a>

source

pub fn struct_span_err_with_code<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str, code: DiagnosticId ) -> DiagnosticBuilder<'a>

source

pub fn struct_err<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>

source

pub fn struct_err_with_code<'a>( &'a self, msg: &str, code: DiagnosticId ) -> DiagnosticBuilder<'a>

source

pub fn struct_span_fatal<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str ) -> DiagnosticBuilder<'a>

source

pub fn struct_span_fatal_with_code<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str, code: DiagnosticId ) -> DiagnosticBuilder<'a>

source

pub fn struct_fatal<'a>(&'a self, msg: &str) -> DiagnosticBuilder<'a>

source

pub fn cancel(&self, err: &mut DiagnosticBuilder<'_>)

source

pub fn span_fatal<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> FatalError

source

pub fn span_fatal_with_code<S: Into<MultiSpan>>( &self, sp: S, msg: &str, code: DiagnosticId ) -> FatalError

source

pub fn span_err<S: Into<MultiSpan>>(&self, sp: S, msg: &str)

source

pub fn mut_span_err<'a, S: Into<MultiSpan>>( &'a self, sp: S, msg: &str ) -> DiagnosticBuilder<'a>

source

pub fn span_err_with_code<S: Into<MultiSpan>>( &self, sp: S, msg: &str, code: DiagnosticId )

source

pub fn span_warn<S: Into<MultiSpan>>(&self, sp: S, msg: &str)

source

pub fn span_warn_with_code<S: Into<MultiSpan>>( &self, sp: S, msg: &str, code: DiagnosticId )

source

pub fn span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> !

source

pub fn delay_span_bug<S: Into<MultiSpan>>(&self, sp: S, msg: &str)

source

pub fn span_bug_no_panic<S: Into<MultiSpan>>(&self, sp: S, msg: &str)

source

pub fn span_note_without_error<S: Into<MultiSpan>>(&self, sp: S, msg: &str)

source

pub fn span_note_diag<'a>( &'a self, sp: Span, msg: &str ) -> DiagnosticBuilder<'a>

source

pub fn span_unimpl<S: Into<MultiSpan>>(&self, sp: S, msg: &str) -> !

source

pub fn failure(&self, msg: &str)

source

pub fn fatal(&self, msg: &str) -> FatalError

source

pub fn err(&self, msg: &str)

source

pub fn warn(&self, msg: &str)

source

pub fn note_without_error(&self, msg: &str)

source

pub fn bug(&self, msg: &str) -> !

source

pub fn unimpl(&self, msg: &str) -> !

source

pub fn err_count(&self) -> usize

source

pub fn has_errors(&self) -> bool

source

pub fn print_error_count(&self)

source

pub fn abort_if_errors(&self)

source

pub fn emit(&self, msp: &MultiSpan, msg: &str, lvl: Level)

source

pub fn emit_with_code( &self, msp: &MultiSpan, msg: &str, code: DiagnosticId, lvl: Level )

source

pub fn must_teach(&self, code: &DiagnosticId) -> bool

true if we haven’t taught a diagnostic with this code already. The caller must then teach the user about such a diagnostic.

Used to suppress emitting the same error multiple times with extended explanation when calling -Z teach.

source

pub fn force_print_db(&self, db: DiagnosticBuilder<'_>)

Trait Implementations§

source§

impl Drop for Handler

source§

fn drop(&mut self)

Executes the destructor for this 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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

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

§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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