mirror of https://github.com/zkat/miette.git
docs: introduce primary param in label
This commit is contained in:
parent
b2011f693b
commit
a5b549a94f
32
README.md
32
README.md
|
|
@ -51,6 +51,7 @@ diagnostic error code: ruget::api::bad_json
|
||||||
- [... handler options](#-handler-options)
|
- [... handler options](#-handler-options)
|
||||||
- [... dynamic diagnostics](#-dynamic-diagnostics)
|
- [... dynamic diagnostics](#-dynamic-diagnostics)
|
||||||
- [... syntax highlighting](#-syntax-highlighting)
|
- [... syntax highlighting](#-syntax-highlighting)
|
||||||
|
- [... primary label](#-primary-label)
|
||||||
- [... collection of labels](#-collection-of-labels)
|
- [... collection of labels](#-collection-of-labels)
|
||||||
- [Acknowledgements](#acknowledgements)
|
- [Acknowledgements](#acknowledgements)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
@ -689,6 +690,37 @@ trait to [`MietteHandlerOpts`] by calling the
|
||||||
[`with_syntax_highlighting`](MietteHandlerOpts::with_syntax_highlighting)
|
[`with_syntax_highlighting`](MietteHandlerOpts::with_syntax_highlighting)
|
||||||
method. See the [`highlighters`] module docs for more details.
|
method. See the [`highlighters`] module docs for more details.
|
||||||
|
|
||||||
|
#### ... primary label
|
||||||
|
|
||||||
|
You can use the `primary` parameter to `label` to indicate that the label
|
||||||
|
is the primary label.
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[derive(Debug, Diagnostic, Error)]
|
||||||
|
#[error("oops!")]
|
||||||
|
struct MyError {
|
||||||
|
#[label(primary, "main issue")]
|
||||||
|
primary_span: SourceSpan,
|
||||||
|
|
||||||
|
#[label("other label")]
|
||||||
|
other_span: SourceSpan,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `primary` parameter can be used at most once:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[derive(Debug, Diagnostic, Error)]
|
||||||
|
#[error("oops!")]
|
||||||
|
struct MyError {
|
||||||
|
#[label(primary, "main issue")]
|
||||||
|
primary_span: SourceSpan,
|
||||||
|
|
||||||
|
#[label(primary, "other label")] // Error: Cannot have more than one primary label.
|
||||||
|
other_span: SourceSpan,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### ... collection of labels
|
#### ... collection of labels
|
||||||
|
|
||||||
When the number of labels is unknown, you can use a collection of `SourceSpan`
|
When the number of labels is unknown, you can use a collection of `SourceSpan`
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue