use-diagnostic 0.0.1

Facade crate for RustUse diagnostic primitives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# use-diagnostic

Facade crate for `RustUse` diagnostic primitives.

`use-diagnostic` reexports the focused crates in the diagnostic set. It is a primitive vocabulary for codes, levels, messages, spans, labels, diagnostics, and reports.

It is not an error framework, logging framework, terminal renderer, CLI output system, or compiler diagnostic system.

## Reexports

- `use_diagnostic_code`
- `use_diagnostic_level`
- `use_diagnostic_message`
- `use_diagnostic_span`
- `use_diagnostic_label`
- `use_diagnostic_report`

## Example

```rust
use use_diagnostic::prelude::{
    Diagnostic, DiagnosticCode, DiagnosticLabel, DiagnosticLevel, DiagnosticMessage,
    DiagnosticPosition, DiagnosticReport, DiagnosticSpan,
};

let code = DiagnosticCode::new("DATA.INVALID_SHAPE").unwrap();
let message = DiagnosticMessage::new("invalid data shape").unwrap();
let start = DiagnosticPosition::new(8, 3).unwrap();
let end = DiagnosticPosition::new(8, 11).unwrap();
let span = DiagnosticSpan::without_source(start, end).unwrap();
let label = DiagnosticLabel::primary(
    DiagnosticMessage::new("expected an object here").unwrap(),
    span,
);

let diagnostic = Diagnostic::new(DiagnosticLevel::Error, message)
    .with_code(code)
    .with_label(label);

let mut report = DiagnosticReport::new();
report.add(diagnostic);

assert!(report.has_errors());
```

## Scope

The facade keeps implementation minimal. It provides reexports and a shared prelude only.

## Status

`use-diagnostic` is a pre-1.0 facade for the focused diagnostic primitive crates.