fix!: Rename Snippet to Message

Author: epage

benches/simple.rs

@@ -4,7 +4,7 @@ extern crate criterion;
 
 use criterion::{black_box, Criterion};
 
-use annotate_snippets::{Label, Renderer, Slice, Snippet};
+use annotate_snippets::{Label, Message, Renderer, Slice};
 
 fn create_snippet(renderer: Renderer) {
     let source = r#") -> Option<String> {
@@ -29,7 +29,7 @@ fn create_snippet(renderer: Renderer) {
             _ => continue,
         }
     }"#;
-    let snippet = Snippet::error("mismatched types").id("E0308").slice(
+    let message = Message::error("mismatched types").id("E0308").slice(
         Slice::new(source, 51)
             .origin("src/format.rs")
             .annotation(
@@ -38,7 +38,7 @@ fn create_snippet(renderer: Renderer) {
             .annotation(Label::error("expected enum `std::option::Option`").span(26..724)),
     );
 
-    let _result = renderer.render(snippet).to_string();
+    let _result = renderer.render(message).to_string();
 }
 
 pub fn criterion_benchmark(c: &mut Criterion) {

examples/expected_type.rs

@@ -1,11 +1,11 @@
-use annotate_snippets::{Label, Renderer, Slice, Snippet};
+use annotate_snippets::{Label, Message, Renderer, Slice};
 
 fn main() {
     let source = r#"                annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     ,
                 range: <22, 25>,"#;
-    let snippet = Snippet::error("expected type, found `22`").slice(
+    let message = Message::error("expected type, found `22`").slice(
         Slice::new(source, 26)
             .origin("examples/footer.rs")
             .fold(true)
@@ -19,5 +19,5 @@ fn main() {
     );
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(snippet));
+    anstream::println!("{}", renderer.render(message));
 }

examples/footer.rs

@@ -1,7 +1,7 @@
-use annotate_snippets::{Label, Renderer, Slice, Snippet};
+use annotate_snippets::{Label, Message, Renderer, Slice};
 
 fn main() {
-    let snippet = Snippet::error("mismatched types")
+    let message = Message::error("mismatched types")
         .id("E0308")
         .slice(
             Slice::new("        slices: vec![\"A\",", 13)
@@ -18,5 +18,5 @@ fn main() {
         ));
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(snippet));
+    anstream::println!("{}", renderer.render(message));
 }

examples/format.rs

@@ -1,4 +1,4 @@
-use annotate_snippets::{Label, Renderer, Slice, Snippet};
+use annotate_snippets::{Label, Message, Renderer, Slice};
 
 fn main() {
     let source = r#") -> Option<String> {
@@ -23,7 +23,7 @@ fn main() {
             _ => continue,
         }
     }"#;
-    let snippet = Snippet::error("mismatched types").id("E0308").slice(
+    let message = Message::error("mismatched types").id("E0308").slice(
         Slice::new(source, 51)
             .origin("src/format.rs")
             .annotation(
@@ -33,5 +33,5 @@ fn main() {
     );
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(snippet));
+    anstream::println!("{}", renderer.render(message));
 }

examples/multislice.rs

@@ -1,10 +1,10 @@
-use annotate_snippets::{Renderer, Slice, Snippet};
+use annotate_snippets::{Message, Renderer, Slice};
 
 fn main() {
-    let snippet = Snippet::error("mismatched types")
+    let message = Message::error("mismatched types")
         .slice(Slice::new("Foo", 51).origin("src/format.rs"))
         .slice(Slice::new("Faa", 129).origin("src/display.rs"));
 
     let renderer = Renderer::styled();
-    anstream::println!("{}", renderer.render(snippet));
+    anstream::println!("{}", renderer.render(message));
 }

src/lib.rs

@@ -16,10 +16,10 @@
 //! The crate uses a three stage process with two conversions between states:
 //!
 //! ```text
-//! Snippet --> Renderer --> impl Display
+//! Message --> Renderer --> impl Display
 //! ```
 //!
-//! The input type - [Snippet] is a structure designed
+//! The input type - [Message] is a structure designed
 //! to align with likely output from any parser whose code snippet is to be
 //! annotated.
 //!

src/renderer/display_list.rs

@@ -106,12 +106,12 @@ impl<'a> DisplayList<'a> {
     const WARNING_TXT: &'static str = "warning";
 
     pub(crate) fn new(
-        snippet::Snippet {
+        snippet::Message {
             title,
             id,
             footer,
             slices,
-        }: snippet::Snippet<'a>,
+        }: snippet::Message<'a>,
         stylesheet: &'a Stylesheet,
         anonymized_line_numbers: bool,
         margin: Option<Margin>,
@@ -1206,7 +1206,7 @@ mod tests {
 
     #[test]
     fn test_format_title() {
-        let input = snippet::Snippet::error("This is a title").id("E0001");
+        let input = snippet::Message::error("This is a title").id("E0001");
         let output = from_display_lines(vec![DisplayLine::Raw(DisplayRawLine::Annotation {
             annotation: Annotation {
                 annotation_type: DisplayAnnotationType::Error,
@@ -1227,7 +1227,7 @@ mod tests {
         let line_1 = "This is line 1";
         let line_2 = "This is line 2";
         let source = [line_1, line_2].join("\n");
-        let input = snippet::Snippet::error("").slice(snippet::Slice::new(&source, 5402));
+        let input = snippet::Message::error("").slice(snippet::Slice::new(&source, 5402));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1277,7 +1277,7 @@ mod tests {
         let src_0_len = src_0.len();
         let src_1 = "This is slice 2";
         let src_1_len = src_1.len();
-        let input = snippet::Snippet::error("")
+        let input = snippet::Message::error("")
             .slice(snippet::Slice::new(src_0, 5402).origin("file1.rs"))
             .slice(snippet::Slice::new(src_1, 2).origin("file2.rs"));
         let output = from_display_lines(vec![
@@ -1350,7 +1350,7 @@ mod tests {
         let source = [line_1, line_2].join("\n");
         // In line 2
         let range = 22..24;
-        let input = snippet::Snippet::error("").slice(
+        let input = snippet::Message::error("").slice(
             snippet::Slice::new(&source, 5402)
                 .annotation(snippet::Label::info("Test annotation").span(range.clone())),
         );
@@ -1420,7 +1420,7 @@ mod tests {
     #[test]
     fn test_format_label() {
         let input =
-            snippet::Snippet::error("").footer(snippet::Label::error("This __is__ a title"));
+            snippet::Message::error("").footer(snippet::Label::error("This __is__ a title"));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1455,7 +1455,7 @@ mod tests {
     fn test_i26() {
         let source = "short";
         let label = "label";
-        let input = snippet::Snippet::error("").slice(
+        let input = snippet::Message::error("").slice(
             snippet::Slice::new(source, 0)
                 .annotation(snippet::Label::error(label).span(0..source.len() + 2)),
         );
@@ -1464,7 +1464,7 @@ mod tests {
 
     #[test]
     fn test_i_29() {
-        let snippets = snippet::Snippet::error("oops").slice(
+        let snippets = snippet::Message::error("oops").slice(
             snippet::Slice::new("First line\r\nSecond oops line", 1)
                 .origin("<current file>")
                 .fold(true)

src/renderer/mod.rs

@@ -1,9 +1,9 @@
-//! The renderer for [`Snippet`]s
+//! The renderer for [`Message`]s
 //!
 //! # Example
 //! ```
-//! use annotate_snippets::{Renderer, Slice, Snippet};
-//! let snippet = Snippet::error("mismatched types")
+//! use annotate_snippets::{Renderer, Slice, Message};
+//! let snippet = Message::error("mismatched types")
 //!     .slice(Slice::new("Foo", 51).origin("src/format.rs"))
 //!     .slice(Slice::new("Faa", 129).origin("src/display.rs"));
 //!
@@ -14,14 +14,14 @@ mod display_list;
 mod margin;
 pub(crate) mod stylesheet;
 
-use crate::snippet::Snippet;
+use crate::snippet::Message;
 pub use anstyle::*;
 use display_list::DisplayList;
 pub use margin::Margin;
 use std::fmt::Display;
 use stylesheet::Stylesheet;
 
-/// A renderer for [`Snippet`]s
+/// A renderer for [`Message`]s
 #[derive(Clone)]
 pub struct Renderer {
     anonymized_line_numbers: bool,
@@ -165,9 +165,9 @@ impl Renderer {
     }
 
     /// Render a snippet into a `Display`able object
-    pub fn render<'a>(&'a self, snippet: Snippet<'a>) -> impl Display + 'a {
+    pub fn render<'a>(&'a self, msg: Message<'a>) -> impl Display + 'a {
         DisplayList::new(
-            snippet,
+            msg,
             &self.stylesheet,
             self.anonymized_line_numbers,
             self.margin,

src/snippet.rs

@@ -5,22 +5,22 @@
 //! ```
 //! use annotate_snippets::*;
 //!
-//! Snippet::error("mismatched types")
+//! Message::error("mismatched types")
 //!     .slice(Slice::new("Foo", 51).origin("src/format.rs"))
 //!     .slice(Slice::new("Faa", 129).origin("src/display.rs"));
 //! ```
 
 use std::ops::Range;
 
 /// Primary structure provided for formatting
-pub struct Snippet<'a> {
+pub struct Message<'a> {
     pub(crate) title: Label<'a>,
     pub(crate) id: Option<&'a str>,
     pub(crate) slices: Vec<Slice<'a>>,
     pub(crate) footer: Vec<Label<'a>>,
 }
 
-impl<'a> Snippet<'a> {
+impl<'a> Message<'a> {
     pub fn title(title: Label<'a>) -> Self {
         Self {
             title,

tests/fixtures/deserialize.rs

@@ -1,18 +1,18 @@
 use serde::{Deserialize, Deserializer, Serialize};
 use std::ops::Range;
 
-use annotate_snippets::{renderer::Margin, Annotation, Label, Level, Renderer, Slice, Snippet};
+use annotate_snippets::{renderer::Margin, Annotation, Label, Level, Message, Renderer, Slice};
 
 #[derive(Deserialize)]
 pub struct Fixture<'a> {
     #[serde(default)]
     pub renderer: RendererDef,
     #[serde(borrow)]
-    pub snippet: SnippetDef<'a>,
+    pub message: MessageDef<'a>,
 }
 
 #[derive(Deserialize)]
-pub struct SnippetDef<'a> {
+pub struct MessageDef<'a> {
     #[serde(deserialize_with = "deserialize_label")]
     #[serde(borrow)]
     pub title: Label<'a>,
@@ -28,25 +28,25 @@ pub struct SnippetDef<'a> {
     pub slices: Vec<Slice<'a>>,
 }
 
-impl<'a> From<SnippetDef<'a>> for Snippet<'a> {
-    fn from(val: SnippetDef<'a>) -> Self {
-        let SnippetDef {
+impl<'a> From<MessageDef<'a>> for Message<'a> {
+    fn from(val: MessageDef<'a>) -> Self {
+        let MessageDef {
             title,
             id,
             footer,
             slices,
         } = val;
-        let mut snippet = Snippet::title(title);
+        let mut message = Message::title(title);
         if let Some(id) = id {
-            snippet = snippet.id(id);
+            message = message.id(id);
         }
-        snippet = slices
+        message = slices
             .into_iter()
-            .fold(snippet, |snippet, slice| snippet.slice(slice));
-        snippet = footer
+            .fold(message, |message, slice| message.slice(slice));
+        message = footer
             .into_iter()
-            .fold(snippet, |snippet, label| snippet.footer(label));
-        snippet
+            .fold(message, |message, label| message.footer(label));
+        message
     }
 }
 

tests/fixtures/main.rs

@@ -1,7 +1,7 @@
 mod deserialize;
 
 use crate::deserialize::Fixture;
-use annotate_snippets::{Renderer, Snippet};
+use annotate_snippets::{Message, Renderer};
 use snapbox::data::DataFormat;
 use snapbox::Data;
 use std::error::Error;
@@ -26,8 +26,8 @@ fn setup(input_path: std::path::PathBuf) -> snapbox::harness::Case {
 
 fn test(input_path: &std::path::Path) -> Result<Data, Box<dyn Error>> {
     let src = std::fs::read_to_string(input_path)?;
-    let (renderer, snippet): (Renderer, Snippet<'_>) =
-        toml::from_str(&src).map(|a: Fixture| (a.renderer.into(), a.snippet.into()))?;
-    let actual = renderer.render(snippet).to_string();
+    let (renderer, message): (Renderer, Message<'_>) =
+        toml::from_str(&src).map(|a: Fixture| (a.renderer.into(), a.message.into()))?;
+    let actual = renderer.render(message).to_string();
     Ok(Data::from(actual).coerce_to(DataFormat::TermSvg))
 }

tests/fixtures/no-color/issue_52.toml

@@ -1,8 +1,8 @@
-[snippet.title]
+[message.title]
 level = "Error"
 label = ""
 
-[[snippet.slices]]
+[[message.slices]]
 source = """
 
 
@@ -11,7 +11,7 @@ invalid syntax
 line_start = 1
 origin = "path/to/error.rs"
 fold = true
-[[snippet.slices.annotations]]
+[[message.slices.annotations]]
 label = "error here"
 level = "Warning"
 range = [2,16]

tests/fixtures/no-color/issue_9.toml

@@ -1,28 +1,28 @@
-[snippet.title]
+[message.title]
 label = "expected one of `.`, `;`, `?`, or an operator, found `for`"
 level = "Error"
 
-[[snippet.slices]]
+[[message.slices]]
 source = "let x = vec![1];"
 line_start = 4
 origin = "/code/rust/src/test/ui/annotate-snippet/suggestion.rs"
-[[snippet.slices.annotations]]
+[[message.slices.annotations]]
 label = "move occurs because `x` has type `std::vec::Vec<i32>`, which does not implement the `Copy` trait"
 level = "Warning"
 range = [4, 5]
 
-[[snippet.slices]]
+[[message.slices]]
 source = "let y = x;"
 line_start = 7
-[[snippet.slices.annotations]]
+[[message.slices.annotations]]
 label = "value moved here"
 level = "Warning"
 range = [8, 9]
 
-[[snippet.slices]]
+[[message.slices]]
 source = "x;"
 line_start = 9
-[[snippet.slices.annotations]]
+[[message.slices.annotations]]
 label = "value used here after move"
 level = "Error"
 range = [0, 1]