Skip to main content

Diagnostic

Struct Diagnostic 

Source
pub struct Diagnostic { /* private fields */ }
Expand description

A non-fatal problem found while reading a model.

Implementations§

Source§

impl Diagnostic

Source

pub fn new(kind: DiagnosticKind, detail: impl Into<String>) -> Self

Records a warning of kind with no source location; add one with the with_* builders.

Source

pub fn warning(byte_range: Range<usize>, detail: impl Into<String>) -> Self

Records a DiagnosticKind::Other warning covering a byte range of the source.

Source

pub fn unlocated(detail: impl Into<String>) -> Self

Records a DiagnosticKind::Other warning with no source location.

Source

pub fn with_byte_range(self, range: Range<usize>) -> Self

Sets the byte range of the source this finding covers.

Source

pub fn with_position(self, position: SourcePosition) -> Self

Sets the line and column where the finding starts.

Source

pub fn with_instance(self, id: EntityId) -> Self

Sets the instance at fault: a skipped record’s id, the duplicated id or the missing id of a dangling reference.

Source

pub fn with_referrer(self, id: EntityId) -> Self

Sets the record holding a dangling reference.

Source

pub fn with_excerpt(self, excerpt: impl Into<String>) -> Self

Sets a short quote of the source this finding covers.

Source

pub const fn severity(&self) -> Severity

Severity of this finding.

Source

pub const fn kind(&self) -> DiagnosticKind

What this finding is about.

Source

pub const fn byte_range(&self) -> Option<&Range<usize>>

Byte range of the source this finding covers, when the codec has one.

Source

pub const fn instance(&self) -> Option<EntityId>

The instance at fault: a skipped record’s id when it was read, the duplicated id, or the missing id of a dangling reference. None for DiagnosticKind::RealWithoutPoint and DiagnosticKind::Other.

Source

pub const fn referrer(&self) -> Option<EntityId>

The record holding the reference, for a DiagnosticKind::DanglingReference only.

Source

pub const fn position(&self) -> Option<SourcePosition>

Line and column where the finding starts, when the codec has one.

Source

pub fn excerpt(&self) -> Option<&str>

A short quote of the source this finding covers.

Source

pub fn detail(&self) -> &str

Human-readable description without a location prefix.

Trait Implementations§

Source§

impl Clone for Diagnostic

Source§

fn clone(&self) -> Diagnostic

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Diagnostic

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Diagnostic

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Diagnostic

Source§

impl PartialEq for Diagnostic

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Diagnostic

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
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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

Source§

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.