Struct Diagnostic

pub struct Diagnostic { /* private fields */ }

Represents a diagnostic originated from a compilation unit.

Arguments are formatted using integer keys counted from 1 (one).

Implementations

impl Diagnostic

pub fn new_syntax_error( location: &Location, kind: DiagnosticKind, arguments: Vec<Rc<dyn DiagnosticArgument>>, ) -> Self

pub fn new_verify_error( location: &Location, kind: DiagnosticKind, arguments: Vec<Rc<dyn DiagnosticArgument>>, ) -> Self

pub fn new_warning( location: &Location, kind: DiagnosticKind, arguments: Vec<Rc<dyn DiagnosticArgument>>, ) -> Self

pub fn location(&self) -> Location

pub fn kind(&self) -> DiagnosticKind

pub fn is_warning(&self) -> bool

pub fn is_error(&self) -> bool

pub fn is_syntax_error(&self) -> bool

pub fn is_verify_error(&self) -> bool

pub fn arguments(&self) -> Vec<Rc<dyn DiagnosticArgument>>

pub fn id(&self) -> i32

pub fn custom_kind(&self) -> Option<Rc<dyn Any>>

pub fn set_custom_kind(&self, id: Option<Rc<dyn Any>>)

pub fn format_with_message(&self, message: &str, id: Option<i32>) -> String

Formats the diagnostic by overriding the message text.

pub fn format_with_message_and_base_path( &self, message: &str, id: Option<i32>, base_path: Option<&str>, ) -> String

Formats the diagnostic by overriding the message text and providing a base Whack package’s path (to relativize the source path).

pub fn format_english(&self) -> String

Formats the diagnostic in English.

pub fn format_english_with_base_path(&self, base_path: &str) -> String

Formats the diagnostic in English.

pub fn format_message_english(&self) -> String

pub fn format_message(&self, messages: &HashMap<i32, String>) -> String

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Ord for Diagnostic

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Diagnostic

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Diagnostic

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Diagnostic