Struct Diagnostic

pub struct Diagnostic<S = Span> {
    pub span: S,
    pub level: Level,
    pub message: String,
}

Diagnostic. A warning or error (or lower Level) with a message and span. Shown by IDEs usually as a squiggly red or yellow underline.

Diagnostics must be emitted via Diagnostic::try_emit, Diagnostic::to_tokens, or Diagnostic::try_emit_all for diagnostics to show up.

Fields

span: S

Span (source code location).

level: Level

Severity level.

message: String

Human-readable message.

Implementations

impl<S> Diagnostic<S>

pub fn is_error(&self) -> bool

If this diagnostic’s level is Level::Error.

impl Diagnostic

pub fn spanned( span: Span, level: Level, message: impl Into<String>, ) -> Diagnostic

Create a new diagnostic from the given span, level, and message.

pub fn try_emit(&self) -> Result<(), TokenStream>

Emit if possible, otherwise return Err containing a TokenStream of a compile_error!(...) call.

pub fn try_emit_all<'a>( diagnostics: impl IntoIterator<Item = &'a Diagnostic>, ) -> Result<(), TokenStream>

Emits all if possible, otherwise returns Err containing a TokenStream of compile_error!(...) calls.

pub fn to_tokens(&self) -> TokenStream

Used to emulate proc_macro::Diagnostic::emit by turning this diagnostic into a properly spanned TokenStream that emits an error via compile_error!(...) with this diagnostic’s message.

pub fn to_serde(&self) -> Diagnostic<SerdeSpan>

Converts this into a serializable and deserializable Diagnostic. Span information is converted into SerdeSpan which keeps the span info but cannot be plugged into or emitted through the Rust compiler’s diagnostic system.

Trait Implementations

impl<S> Clone for Diagnostic<S>

where S: Clone,

fn clone(&self) -> Diagnostic<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for Diagnostic<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Diagnostic<S>

where S: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Diagnostic<S>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl Display for Diagnostic<SerdeSpan>

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

Formats the value using the given formatter.

impl From<Error> for Diagnostic

fn from(value: Error) -> Diagnostic

Converts to this type from the input type.

impl<S> Serialize for Diagnostic<S>

where S: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.