Struct Diagnostic 

#[non_exhaustive]
pub struct Diagnostic {
    pub severity: Severity,
    pub message: String,
    pub location: Option<Location>,
    pub hints: Vec<String>,
}

A single problem found while running a command.

#[non_exhaustive] because this is an output type that consumers read rather than construct, so that adding detail later — label text, related locations — is not a breaking change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

severity: Severity

How much this diagnostic matters.

message: String

Human-readable description of the problem, one line, no trailing period.

location: Option<Location>

Where the problem is, when that is known.

hints: Vec<String>

Suggestions for fixing the problem, most useful first. Often a ready-to-apply replacement, so worth surfacing to the user verbatim. May be empty.

Unlike the Option fields above, default is load-bearing here: skip_serializing_if on a non-Option omits the key entirely, and without default that omission fails to deserialize.

Implementations

impl Diagnostic

pub fn warning(message: impl Into<String>) -> Self

A diagnostic with Severity::Warning, no location and no hints.

pub fn error(message: impl Into<String>) -> Self

A diagnostic with Severity::Error, no location and no hints.

pub fn hint(message: impl Into<String>) -> Self

A diagnostic with Severity::Hint, no location and no hints.

The severity is a suggestion about the input; hints are suggested fixes. A Hint diagnostic may carry hints of its own.

pub fn at_file(self, file: impl Into<Utf8PathBuf>) -> Self

Attach a source file to this diagnostic, keeping any span already set.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Diagnostic

impl PartialEq for Diagnostic

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Diagnostic

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Diagnostic