Skip to content

Commit d3b79b6

Browse files
committed
fix!: Rename Level::title/Level::message to Level::header
This doesn't completely take care of rust-lang#118 because of rust-lang#196
1 parent f6d1914 commit d3b79b6

30 files changed

+126
-126
lines changed

benches/bench.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ fn simple() -> String {
2424
_ => continue,
2525
}
2626
}"#;
27-
let message = Level::ERROR.message("mismatched types").id("E0308").group(
27+
let message = Level::ERROR.header("mismatched types").id("E0308").group(
2828
Group::new().element(
2929
Snippet::source(source)
3030
.line_start(51)
@@ -69,7 +69,7 @@ fn fold(bencher: divan::Bencher<'_, '_>, context: usize) {
6969
(input, span)
7070
})
7171
.bench_values(|(input, span)| {
72-
let message = Level::ERROR.message("mismatched types").id("E0308").group(
72+
let message = Level::ERROR.header("mismatched types").id("E0308").group(
7373
Group::new().element(
7474
Snippet::source(&input)
7575
.fold(true)

examples/custom_error.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pub static C: u32 = 0 - 1;
1717
"#;
1818
let message = Level::ERROR
1919
.text(Some("error: internal compiler error"))
20-
.message("could not evaluate static initializer")
20+
.header("could not evaluate static initializer")
2121
.id("E0080")
2222
.group(
2323
Group::new().element(

examples/custom_level.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ fn main() {
3030
}
3131
"#;
3232
let message = Level::ERROR
33-
.message("`break` with value from a `while` loop")
33+
.header("`break` with value from a `while` loop")
3434
.id("E0571")
3535
.group(
3636
Group::new().element(

examples/expected_type.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ fn main() {
66
,
77
range: <22, 25>,"#;
88
let message =
9-
Level::ERROR.message("expected type, found `22`").group(
9+
Level::ERROR.header("expected type, found `22`").group(
1010
Group::new().element(
1111
Snippet::source(source)
1212
.line_start(26)

examples/footer.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};
22

33
fn main() {
44
let message = Level::ERROR
5-
.message("mismatched types")
5+
.header("mismatched types")
66
.id("E0308")
77
.group(
88
Group::new().element(

examples/format.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ fn main() {
2323
_ => continue,
2424
}
2525
}"#;
26-
let message = Level::ERROR.message("mismatched types").id("E0308").group(
26+
let message = Level::ERROR.header("mismatched types").id("E0308").group(
2727
Group::new().element(
2828
Snippet::source(source)
2929
.line_start(51)

examples/highlight_source.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const CON: Vec<i32> = vec![1, 2, 3]; //~ ERROR E0010
1010
fn main() {}
1111
"#;
1212
let message = Level::ERROR
13-
.message("allocations are not allowed in constants")
13+
.header("allocations are not allowed in constants")
1414
.id("E0010")
1515
.group(
1616
Group::new()

examples/highlight_title.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ fn main() {
4343
magenta.render_reset()
4444
);
4545

46-
let message = Level::ERROR.message("mismatched types").id("E0308").group(
46+
let message = Level::ERROR.header("mismatched types").id("E0308").group(
4747
Group::new()
4848
.element(
4949
Snippet::source(source)

examples/multislice.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use annotate_snippets::{Annotation, Group, Level, Renderer, Snippet};
22

33
fn main() {
4-
let message = Level::ERROR.message("mismatched types").group(
4+
let message = Level::ERROR.header("mismatched types").group(
55
Group::new()
66
.element(
77
Snippet::<Annotation<'_>>::source("Foo")

src/level.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ impl<'a> Level<'a> {
5656
/// Text passed to this function is considered "untrusted input", as such
5757
/// all text is passed through a normalization function. Pre-styled text is
5858
/// not allowed to be passed to this function.
59-
pub fn message(self, title: &'a str) -> Message<'a> {
59+
pub fn header(self, header: &'a str) -> Message<'a> {
6060
Message {
6161
id: None,
6262
groups: vec![Group::new().element(Element::Title(Title {
6363
level: self,
64-
title,
64+
title: header,
6565
primary: true,
6666
}))],
6767
}

src/renderer/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
//! }
2020
//! "#;
2121
//! Level::ERROR
22-
//! .message("unresolved import `baz::zed`")
22+
//! .header("unresolved import `baz::zed`")
2323
//! .id("E0432")
2424
//! .group(
2525
//! Group::new().element(

tests/fixtures/color/ann_eof.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = "expected `.`, `=`"
3+
header = "expected `.`, `=`"
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/ann_insertion.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = "expected `.`, `=`"
3+
header = "expected `.`, `=`"
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/ann_multiline.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0027"
4-
title = "pattern does not mention fields `lineno`, `content`"
4+
header = "pattern does not mention fields `lineno`, `content`"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/ann_multiline2.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E####"
4-
title = "spacing error found"
4+
header = "spacing error found"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/ann_removed_nl.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = "expected `.`, `=`"
3+
header = "expected `.`, `=`"
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/ensure-emoji-highlight-width.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[message]
2-
title = "invalid character ` ` in package name: `haha this isn't a valid name 🐛`, characters must be Unicode XID characters (numbers, `-`, `_`, or most letters)"
2+
header = "invalid character ` ` in package name: `haha this isn't a valid name 🐛`, characters must be Unicode XID characters (numbers, `-`, `_`, or most letters)"
33
level = "Error"
44

55

tests/fixtures/color/fold_ann_multiline.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "mismatched types"
4+
header = "mismatched types"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/fold_bad_origin_line.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = ""
3+
header = ""
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/fold_leading.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "invalid type: integer `20`, expected a bool"
4+
header = "invalid type: integer `20`, expected a bool"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/fold_trailing.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "invalid type: integer `20`, expected a lints table"
4+
header = "invalid type: integer `20`, expected a lints table"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/issue_9.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = "expected one of `.`, `;`, `?`, or an operator, found `for`"
3+
header = "expected one of `.`, `;`, `?`, or an operator, found `for`"
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/multiple_annotations.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = ""
3+
header = ""
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/simple.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[message]
22
level = "Error"
3-
title = "expected one of `.`, `;`, `?`, or an operator, found `for`"
3+
header = "expected one of `.`, `;`, `?`, or an operator, found `for`"
44

55
[[message.sections]]
66
type = "Cause"

tests/fixtures/color/strip_line.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "mismatched types"
4+
header = "mismatched types"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/strip_line_char.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "mismatched types"
4+
header = "mismatched types"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/color/strip_line_non_ws.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[message]
22
level = "Error"
33
id = "E0308"
4-
title = "mismatched types"
4+
header = "mismatched types"
55

66
[[message.sections]]
77
type = "Cause"

tests/fixtures/deserialize.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ pub(crate) struct Fixture {
1616
#[derive(Deserialize)]
1717
pub struct MessageDef {
1818
pub level: LevelDef,
19-
pub title: String,
19+
pub header: String,
2020
#[serde(default)]
2121
pub id: Option<String>,
2222
#[serde(default)]
@@ -27,11 +27,11 @@ impl<'a> From<&'a MessageDef> for Message<'a> {
2727
fn from(val: &'a MessageDef) -> Self {
2828
let MessageDef {
2929
level,
30-
title,
30+
header,
3131
id,
3232
sections,
3333
} = val;
34-
let mut message = Level::from(level).message(title);
34+
let mut message = Level::from(level).header(header);
3535
if let Some(id) = id {
3636
message = message.id(id);
3737
}

0 commit comments

Comments
 (0)