Struct Diagnostics

pub struct Diagnostics<TEntry: DiagnosticEntry>(pub Arc<DiagnosticsBuilder<TEntry>>);

A set of diagnostic entries that arose during a computation.

Tuple Fields

0: Arc<DiagnosticsBuilder<TEntry>>

Implementations

impl<TEntry: DiagnosticEntry> Diagnostics<TEntry>

pub fn new() -> Self

pub fn check_error_free(&self) -> Maybe<()>

Returns Ok if there are no errors, or DiagnosticAdded if there are.

pub fn is_empty(&self) -> bool

Checks if there are no entries inside Diagnostics

pub fn format_with_severity( &self, db: &TEntry::DbType, file_notes: &OrderedHashMap<FileId, DiagnosticNote>, ) -> Vec<FormattedDiagnosticEntry>

Format entries to pairs of severity and message.

pub fn format(&self, db: &TEntry::DbType) -> String

Format entries to a String with messages prefixed by severity.

pub fn expect(&self, error_message: &str)

Asserts that no diagnostic has occurred, panicking with an error message on failure.

pub fn expect_with_db(&self, db: &TEntry::DbType, error_message: &str)

Same as Self::expect, except that the diagnostics are formatted.

pub fn get_all(&self) -> Vec<TEntry>

Get all diagnostics.

pub fn get_diagnostics_without_duplicates( &self, db: &TEntry::DbType, ) -> Vec<TEntry>

Get diagnostics without duplication.

Two diagnostics are considered duplicated if both point to the same location in the user code, and are of the same kind.

Trait Implementations

impl<TEntry: Clone + DiagnosticEntry> Clone for Diagnostics<TEntry>

fn clone(&self) -> Diagnostics<TEntry>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TEntry: Debug + DiagnosticEntry> Debug for Diagnostics<TEntry>

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

Formats the value using the given formatter.

impl<TEntry: DiagnosticEntry> Default for Diagnostics<TEntry>

fn default() -> Self

Returns the “default value” for a type.

impl<TEntry: DiagnosticEntry> From<Diagnostics<TEntry>> for DiagnosticsBuilder<TEntry>

fn from(diagnostics: Diagnostics<TEntry>) -> Self

Converts to this type from the input type.

impl<TEntry: DiagnosticEntry> FromIterator<TEntry> for Diagnostics<TEntry>

fn from_iter<T: IntoIterator<Item = TEntry>>(diags_iter: T) -> Self

Creates a value from an iterator.

impl<TEntry: Hash + DiagnosticEntry> Hash for Diagnostics<TEntry>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<TEntry: PartialEq + DiagnosticEntry> PartialEq for Diagnostics<TEntry>

fn eq(&self, other: &Diagnostics<TEntry>) -> 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<TEntry: Eq + DiagnosticEntry> Eq for Diagnostics<TEntry>

impl<TEntry: DiagnosticEntry> StructuralPartialEq for Diagnostics<TEntry>