use-diagnostic-message 0.0.1

Plain-text diagnostic message primitives for RustUse
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

# use-diagnostic-message

Plain-text diagnostic message primitives for `RustUse`.

## Foundation

`use-diagnostic-message` provides `DiagnosticMessage` and `DiagnosticNote`, small string-backed values for human-facing diagnostic text.

Messages and notes are trimmed at the edges, reject empty values, and remain renderer-neutral. They do not carry Markdown, ANSI, color, terminal, or layout assumptions.

## Example

```rust
use use_diagnostic_message::{DiagnosticMessage, DiagnosticNote};

let message = DiagnosticMessage::new(" missing required field ").unwrap();
let note = DiagnosticNote::new("field names are case-sensitive").unwrap();

assert_eq!(message.as_str(), "missing required field");
assert_eq!(note.to_string(), "field names are case-sensitive");
```

## Scope

- Messages and notes are plain text.
- The crate validates presence, not grammar or style.
- Formatting, colors, markup, and terminal rendering are out of scope.

## Status

`use-diagnostic-message` is a pre-1.0 crate with a deliberately small API.