Skip to main content

Crate runic_diagnostics

Crate runic_diagnostics 

Source

Macros§

diagnostic
diagnostic_codes
panic_report
report

Structs§

AnnotateRenderer
Strict adapter from prepared snapshots to annotate-snippets.
ColumnIndex
A zero-indexed column number
ColumnNumber
A one-indexed column number
ContextFrame
An owned report context captured as text.
DefaultFailurePolicy
The default policy: only effective error occurrences fail.
DescriptorOrigin
The definition site of a static diagnostic descriptor.
DiagnosticCode
A static, namespaced diagnostic code.
DiagnosticCodeOwned
An owned, exact diagnostic code captured for one occurrence.
DiagnosticCodeRef
A borrowed diagnostic code used by runtime-only diagnostics.
DiagnosticCollector
Mutable collection of owned diagnostics.
DiagnosticDescriptor
Static identity and documentation for a diagnostic kind.
DiagnosticDisplay
A borrowing adapter for rich formatting of one owned diagnostic.
DiagnosticEntry
One finalized diagnostic occurrence.
DiagnosticInstanceId
An opaque ID scoped to one finalized diagnostic set.
DiagnosticLimits
Optional limits over accepted user diagnostics.
DiagnosticMetadata
Lightweight semantic metadata passed to a failure policy.
DiagnosticSet
An immutable set of diagnostics.
DiagnosticSnapshot
A backend-neutral, source-text-free snapshot of one diagnostic.
EmissionFailure
EmissionSummary
ExitWithOutcome
A rich application result that emits every diagnostic before returning.
FmtEmitter
IoEmitter
Label
LayeredSourceProvider
Resolves session and diagnostic-attached source universes without fallback.
LineColumn
One-based human-readable source coordinates.
LineIndex
A zero-indexed line number
LineNumber
A one-indexed line number
MergeSummary
Summary of importing a finalized set into a collector.
Note
Outcome
An Outcome represents the output of a computation and the set of diagnostics that were produced during that computation. Diagnostics may or may not indicate failure, so this type does not treat an outcome as either/or - a successful outcome may still produce diagnostics, which is the primary distinction between this type and core::result::Result<T, E>.
OwnedCause
OwnedDiagnostic
An owned, transport-safe diagnostic occurrence.
OwnedLabel
OwnedNote
OwnedSuggestion
OwnedTextEdit
PanicHookOptions
Configuration captured by the process-global diagnostic panic hook.
PreparationLimits
Finite resource bounds applied independently to each prepared root.
PreparedDiagnostic
A prepared snapshot paired with the exact source universes it references.
PreparedSet
A repeatably iterable prepared diagnostic set.
RenderConfig
A fully resolved, portable rendering configuration.
Report
A failed-computation wrapper that promotes its occurrence to error.
ResolvedSource
A resolved source that retains its complete provenance key.
SeverityCounts
Counts occurrences at each public severity.
SharedSourceProvider
A cloneable, type-erased source provider suitable for retaining with owned diagnostics.
Source
A borrowed source resolved from a provider.
SourceId
A source identity scoped to a provider/session namespace.
SourceMap
Built-in owned source provider for no_std + alloc applications.
SourceNamespace
A caller-coordinated source identity namespace.
SourceRevision
SourceSpan
A range together with exact source provenance and an optional revision.
Span
This type is used to wrap any T with a SourceSpan, and is typically used when it is not convenient to add a SourceSpan to the type - most commonly because we don’t control the type.
StaticRegistry
A deterministic view over explicitly composed diagnostic catalogs.
StderrEmitter
Emits diagnostics to stderr using capabilities resolved at construction.
StdoutEmitter
Emits diagnostics to stdout using capabilities resolved at construction.
Suggestion
TerminalPolicy
Controls terminal capabilities for standard-stream rendering.
TextEdit
TextRange
A validated, half-open byte range.
WarningsAsErrors
A FailurePolicy that treats both warnings and errors as failure.

Enums§

Applicability
DiagnosticRelation
DiagnosticRenderError
A failure while preparing or rendering one owned diagnostic.
DiagnosticTag
Standardized semantic tags
EmissionStatus
Explanation
Availability of a descriptor’s long-form explanation.
InstallHookError
Why a process-global diagnostic panic hook could not be installed.
IoEmissionError
LabelStyle
LookupError
Failure to resolve a diagnostic code.
NoteKind
PreparationItemKind
PrepareError
PushResult
Result of pushing one user diagnostic into a sink.
RegistryError
Failure to construct or validate a diagnostic registry.
RenderError
Severity
The semantic severity of a diagnostic occurrence.
SourceKey
Provenance for a source identity.
SourceMapError
TerminalChoice
An explicit override or environment-derived terminal choice.
TerminalWidth
An explicit render width or a width derived from the terminal environment.
TextRangeError

Traits§

Diagnostic
An object-safe semantic diagnostic occurrence.
DiagnosticSink
Represents a type-erased diagnostic sink for use in libraries.
Emitter
Object-safe presentation boundary. Emission never decides failure policy.
FailurePolicy
Decides whether one semantic diagnostic occurrence makes an outcome fail.
IntoDiagnostic
Convenience trait that adds a into_diagnostic method that converts a type implementing core::error::Error to a Result<T, Report>.
SourceProvider
Resolves one source universe by namespaced source ID.
Spanned
This trait should be implemented for any type that has an associated SourceSpan.
VisitDiagnostic
A synchronous visitor over one diagnostic’s structured children.
VisitTextEdit
A synchronous visitor over the edits in one suggestion.
VisitTextEdits
A synchronous producer of the edits in one atomic suggestion.
WrapErr

Functions§

install_panic_hook
Installs the process-global diagnostic panic hook.
prepare_ref
prepare_ref_with_limits

Type Aliases§

Result

Derive Macros§

Diagnostic
Spanned