Skip to content

Commit 86823c4

Browse files
committed
fix!: Rename Snippet::new to Snippet::source
1 parent 39672b2 commit 86823c4

File tree

10 files changed

+31
-23
lines changed

10 files changed

+31
-23
lines changed

benches/simple.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ fn create_snippet(renderer: Renderer) {
3030
}
3131
}"#;
3232
let message = Level::Error.title("mismatched types").id("E0308").snippet(
33-
Snippet::new(source)
33+
Snippet::source(source)
3434
.line_start(51)
3535
.origin("src/format.rs")
3636
.annotation(

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 = Level::Error.title("expected type, found `22`").snippet(
9-
Snippet::new(source)
9+
Snippet::source(source)
1010
.line_start(26)
1111
.origin("examples/footer.rs")
1212
.fold(true)

examples/footer.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ fn main() {
55
.title("mismatched types")
66
.id("E0308")
77
.snippet(
8-
Snippet::new(" slices: vec![\"A\",")
8+
Snippet::source(" slices: vec![\"A\",")
99
.line_start(13)
1010
.origin("src/multislice.rs")
1111
.annotation(

examples/format.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ fn main() {
2424
}
2525
}"#;
2626
let message = Level::Error.title("mismatched types").id("E0308").snippet(
27-
Snippet::new(source)
27+
Snippet::source(source)
2828
.line_start(51)
2929
.origin("src/format.rs")
3030
.annotation(

examples/multislice.rs

+10-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@ use annotate_snippets::{Level, Renderer, Snippet};
33
fn main() {
44
let message = Level::Error
55
.title("mismatched types")
6-
.snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
7-
.snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
6+
.snippet(
7+
Snippet::source("Foo")
8+
.line_start(51)
9+
.origin("src/format.rs"),
10+
)
11+
.snippet(
12+
Snippet::source("Faa")
13+
.line_start(129)
14+
.origin("src/display.rs"),
15+
);
816

917
let renderer = Renderer::styled();
1018
anstream::println!("{}", renderer.render(message));

src/renderer/display_list.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -1236,7 +1236,7 @@ mod tests {
12361236
let source = [line_1, line_2].join("\n");
12371237
let input = snippet::Level::Error
12381238
.title("")
1239-
.snippet(snippet::Snippet::new(&source).line_start(5402));
1239+
.snippet(snippet::Snippet::source(&source).line_start(5402));
12401240
let output = from_display_lines(vec![
12411241
DisplayLine::Raw(DisplayRawLine::Annotation {
12421242
annotation: Annotation {
@@ -1289,12 +1289,12 @@ mod tests {
12891289
let input = snippet::Level::Error
12901290
.title("")
12911291
.snippet(
1292-
snippet::Snippet::new(src_0)
1292+
snippet::Snippet::source(src_0)
12931293
.line_start(5402)
12941294
.origin("file1.rs"),
12951295
)
12961296
.snippet(
1297-
snippet::Snippet::new(src_1)
1297+
snippet::Snippet::source(src_1)
12981298
.line_start(2)
12991299
.origin("file2.rs"),
13001300
);
@@ -1369,7 +1369,7 @@ mod tests {
13691369
// In line 2
13701370
let range = 22..24;
13711371
let input = snippet::Level::Error.title("").snippet(
1372-
snippet::Snippet::new(&source)
1372+
snippet::Snippet::source(&source)
13731373
.line_start(5402)
13741374
.annotation(snippet::Label::info("Test annotation").span(range.clone())),
13751375
);
@@ -1476,7 +1476,7 @@ mod tests {
14761476
let source = "short";
14771477
let label = "label";
14781478
let input = snippet::Level::Error.title("").snippet(
1479-
snippet::Snippet::new(source)
1479+
snippet::Snippet::source(source)
14801480
.line_start(0)
14811481
.annotation(snippet::Label::error(label).span(0..source.len() + 2)),
14821482
);
@@ -1486,7 +1486,7 @@ mod tests {
14861486
#[test]
14871487
fn test_i_29() {
14881488
let snippets = snippet::Level::Error.title("oops").snippet(
1489-
snippet::Snippet::new("First line\r\nSecond oops line")
1489+
snippet::Snippet::source("First line\r\nSecond oops line")
14901490
.line_start(1)
14911491
.origin("<current file>")
14921492
.fold(true)

src/renderer/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
//! ```
55
//! use annotate_snippets::{Renderer, Snippet, Level};
66
//! let snippet = Level::Error.title("mismatched types")
7-
//! .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
8-
//! .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
7+
//! .snippet(Snippet::source("Foo").line_start(51).origin("src/format.rs"))
8+
//! .snippet(Snippet::source("Faa").line_start(129).origin("src/display.rs"));
99
//!
1010
//! let renderer = Renderer::styled();
1111
//! println!("{}", renderer.render(snippet));

src/snippet.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//! use annotate_snippets::*;
77
//!
88
//! Level::Error.title("mismatched types")
9-
//! .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
10-
//! .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
9+
//! .snippet(Snippet::source("Foo").line_start(51).origin("src/format.rs"))
10+
//! .snippet(Snippet::source("Faa").line_start(129).origin("src/display.rs"));
1111
//! ```
1212
1313
use std::ops::Range;
@@ -100,7 +100,7 @@ pub struct Snippet<'a> {
100100
}
101101

102102
impl<'a> Snippet<'a> {
103-
pub fn new(source: &'a str) -> Self {
103+
pub fn source(source: &'a str) -> Self {
104104
Self {
105105
origin: None,
106106
line_start: 1,

tests/fixtures/deserialize.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ impl<'a> From<SnippetDef<'a>> for Snippet<'a> {
107107
annotations,
108108
fold,
109109
} = val;
110-
let mut snippet = Snippet::new(source).line_start(line_start).fold(fold);
110+
let mut snippet = Snippet::source(source).line_start(line_start).fold(fold);
111111
if let Some(origin) = origin {
112112
snippet = snippet.origin(origin)
113113
}

tests/formatter.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use annotate_snippets::{Label, Level, Renderer, Snippet};
33
#[test]
44
fn test_i_29() {
55
let snippets = Level::Error.title("oops").snippet(
6-
Snippet::new("First line\r\nSecond oops line")
6+
Snippet::source("First line\r\nSecond oops line")
77
.origin("<current file>")
88
.annotation(Label::error("oops").span(19..23))
99
.fold(true),
@@ -23,7 +23,7 @@ fn test_i_29() {
2323
#[test]
2424
fn test_point_to_double_width_characters() {
2525
let snippets = Level::Error.title("").snippet(
26-
Snippet::new("こんにちは、世界")
26+
Snippet::source("こんにちは、世界")
2727
.origin("<current file>")
2828
.annotation(Label::error("world").span(12..16)),
2929
);
@@ -42,7 +42,7 @@ fn test_point_to_double_width_characters() {
4242
#[test]
4343
fn test_point_to_double_width_characters_across_lines() {
4444
let snippets = Level::Error.title("").snippet(
45-
Snippet::new("おはよう\nございます")
45+
Snippet::source("おはよう\nございます")
4646
.origin("<current file>")
4747
.annotation(Label::error("Good morning").span(4..15)),
4848
);
@@ -63,7 +63,7 @@ fn test_point_to_double_width_characters_across_lines() {
6363
#[test]
6464
fn test_point_to_double_width_characters_multiple() {
6565
let snippets = Level::Error.title("").snippet(
66-
Snippet::new("お寿司\n食べたい🍣")
66+
Snippet::source("お寿司\n食べたい🍣")
6767
.origin("<current file>")
6868
.annotation(Label::error("Sushi1").span(0..6))
6969
.annotation(Label::note("Sushi2").span(11..15)),
@@ -85,7 +85,7 @@ fn test_point_to_double_width_characters_multiple() {
8585
#[test]
8686
fn test_point_to_double_width_characters_mixed() {
8787
let snippets = Level::Error.title("").snippet(
88-
Snippet::new("こんにちは、新しいWorld!")
88+
Snippet::source("こんにちは、新しいWorld!")
8989
.origin("<current file>")
9090
.annotation(Label::error("New world").span(12..23)),
9191
);

0 commit comments

Comments
 (0)