fix!: Rename Slice to Snippet

Author: epage

benches/simple.rs

@@ -4,7 +4,7 @@ extern crate criterion;
 
 use criterion::{black_box, Criterion};
 
-use annotate_snippets::{Label, Message, Renderer, Slice};
+use annotate_snippets::{Label, Message, Renderer, Snippet};
 
 fn create_snippet(renderer: Renderer) {
     let source = r#") -> Option<String> {
@@ -29,8 +29,8 @@ fn create_snippet(renderer: Renderer) {
             _ => continue,
         }
     }"#;
-    let snippet = Message::error("mismatched types").id("E0308").slice(
-        Slice::new(source, 51)
+    let snippet = Message::error("mismatched types").id("E0308").snippet(
+        Snippet::new(source, 51)
             .origin("src/format.rs")
             .annotation(
                 Label::warning("expected `Option<String>` because of return type").span(5..19),

examples/expected_type.rs

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

examples/footer.rs

@@ -1,10 +1,10 @@
-use annotate_snippets::{Label, Message, Renderer, Slice};
+use annotate_snippets::{Label, Message, Renderer, Snippet};
 
 fn main() {
     let snippet = Message::error("mismatched types")
         .id("E0308")
-        .slice(
-            Slice::new("        slices: vec![\"A\",", 13)
+        .snippet(
+            Snippet::new("        slices: vec![\"A\",", 13)
                 .origin("src/multislice.rs")
                 .annotation(
                     Label::error(

examples/format.rs

@@ -1,4 +1,4 @@
-use annotate_snippets::{Label, Message, Renderer, Slice};
+use annotate_snippets::{Label, Message, Renderer, Snippet};
 
 fn main() {
     let source = r#") -> Option<String> {
@@ -23,8 +23,8 @@ fn main() {
             _ => continue,
         }
     }"#;
-    let snippet = Message::error("mismatched types").id("E0308").slice(
-        Slice::new(source, 51)
+    let snippet = Message::error("mismatched types").id("E0308").snippet(
+        Snippet::new(source, 51)
             .origin("src/format.rs")
             .annotation(
                 Label::warning("expected `Option<String>` because of return type").span(5..19),

examples/multislice.rs

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

src/renderer/display_list.rs

@@ -110,7 +110,7 @@ impl<'a> DisplayList<'a> {
             title,
             id,
             footer,
-            slices,
+            snippets,
         }: snippet::Message<'a>,
         stylesheet: &'a Stylesheet,
         anonymized_line_numbers: bool,
@@ -120,7 +120,7 @@ impl<'a> DisplayList<'a> {
 
         body.push(format_title(title, id));
 
-        for (idx, slice) in slices.into_iter().enumerate() {
+        for (idx, slice) in snippets.into_iter().enumerate() {
             body.append(&mut format_slice(
                 slice,
                 idx == 0,
@@ -542,7 +542,7 @@ pub enum DisplayLine<'a> {
 /// A source line.
 #[derive(Debug, PartialEq)]
 pub enum DisplaySourceLine<'a> {
-    /// A line with the content of the Slice.
+    /// A line with the content of the Snippet.
     Content {
         text: &'a str,
         range: (usize, usize), // meta information for annotation placement.
@@ -762,7 +762,7 @@ fn format_footer(footer: snippet::Label<'_>) -> Vec<DisplayLine<'_>> {
 }
 
 fn format_slice(
-    slice: snippet::Slice<'_>,
+    slice: snippet::Snippet<'_>,
     is_first: bool,
     has_footer: bool,
     margin: Option<Margin>,
@@ -942,7 +942,7 @@ fn fold_body(mut body: Vec<DisplayLine<'_>>) -> Vec<DisplayLine<'_>> {
 }
 
 fn format_body(
-    slice: snippet::Slice<'_>,
+    slice: snippet::Snippet<'_>,
     need_empty_header: bool,
     has_footer: bool,
     margin: Option<Margin>,
@@ -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::Message::error("").slice(snippet::Slice::new(&source, 5402));
+        let input = snippet::Message::error("").snippet(snippet::Snippet::new(&source, 5402));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1278,8 +1278,8 @@ mod tests {
         let src_1 = "This is slice 2";
         let src_1_len = src_1.len();
         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"));
+            .snippet(snippet::Snippet::new(src_0, 5402).origin("file1.rs"))
+            .snippet(snippet::Snippet::new(src_1, 2).origin("file2.rs"));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1350,8 +1350,8 @@ mod tests {
         let source = [line_1, line_2].join("\n");
         // In line 2
         let range = 22..24;
-        let input = snippet::Message::error("").slice(
-            snippet::Slice::new(&source, 5402)
+        let input = snippet::Message::error("").snippet(
+            snippet::Snippet::new(&source, 5402)
                 .annotation(snippet::Label::info("Test annotation").span(range.clone())),
         );
         let output = from_display_lines(vec![
@@ -1455,17 +1455,17 @@ mod tests {
     fn test_i26() {
         let source = "short";
         let label = "label";
-        let input = snippet::Message::error("").slice(
-            snippet::Slice::new(source, 0)
+        let input = snippet::Message::error("").snippet(
+            snippet::Snippet::new(source, 0)
                 .annotation(snippet::Label::error(label).span(0..source.len() + 2)),
         );
         let _ = DisplayList::new(input, &STYLESHEET, false, None);
     }
 
     #[test]
     fn test_i_29() {
-        let snippets = snippet::Message::error("oops").slice(
-            snippet::Slice::new("First line\r\nSecond oops line", 1)
+        let snippets = snippet::Message::error("oops").snippet(
+            snippet::Snippet::new("First line\r\nSecond oops line", 1)
                 .origin("<current file>")
                 .fold(true)
                 .annotation(snippet::Label::error("oops").span(19..23)),

src/renderer/mod.rs

@@ -2,10 +2,10 @@
 //!
 //! # Example
 //! ```
-//! use annotate_snippets::{Renderer, Slice, Message};
+//! use annotate_snippets::{Renderer, Snippet, 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"));
+//!     .snippet(Snippet::new("Foo", 51).origin("src/format.rs"))
+//!     .snippet(Snippet::new("Faa", 129).origin("src/display.rs"));
 //!
 //!  let renderer = Renderer::styled();
 //!  println!("{}", renderer.render(snippet));

src/snippet.rs

@@ -6,8 +6,8 @@
 //! use annotate_snippets::*;
 //!
 //! Message::error("mismatched types")
-//!     .slice(Slice::new("Foo", 51).origin("src/format.rs"))
-//!     .slice(Slice::new("Faa", 129).origin("src/display.rs"));
+//!     .snippet(Snippet::new("Foo", 51).origin("src/format.rs"))
+//!     .snippet(Snippet::new("Faa", 129).origin("src/display.rs"));
 //! ```
 
 use std::ops::Range;
@@ -16,7 +16,7 @@ use std::ops::Range;
 pub struct Message<'a> {
     pub(crate) title: Label<'a>,
     pub(crate) id: Option<&'a str>,
-    pub(crate) slices: Vec<Slice<'a>>,
+    pub(crate) snippets: Vec<Snippet<'a>>,
     pub(crate) footer: Vec<Label<'a>>,
 }
 
@@ -25,7 +25,7 @@ impl<'a> Message<'a> {
         Self {
             title,
             id: None,
-            slices: vec![],
+            snippets: vec![],
             footer: vec![],
         }
     }
@@ -55,8 +55,8 @@ impl<'a> Message<'a> {
         self
     }
 
-    pub fn slice(mut self, slice: Slice<'a>) -> Self {
-        self.slices.push(slice);
+    pub fn snippet(mut self, slice: Snippet<'a>) -> Self {
+        self.snippets.push(slice);
         self
     }
 
@@ -100,7 +100,7 @@ impl<'a> Label<'a> {
         self
     }
 
-    /// Create a [`Annotation`] with the given span for a [`Slice`]
+    /// Create a [`Annotation`] with the given span for a [`Snippet`]
     pub fn span(&self, span: Range<usize>) -> Annotation<'a> {
         Annotation {
             range: span,
@@ -113,17 +113,17 @@ impl<'a> Label<'a> {
 /// Structure containing the slice of text to be annotated and
 /// basic information about the location of the slice.
 ///
-/// One `Slice` is meant to represent a single, continuous,
+/// One `Snippet` is meant to represent a single, continuous,
 /// slice of source code that you want to annotate.
-pub struct Slice<'a> {
+pub struct Snippet<'a> {
     pub(crate) source: &'a str,
     pub(crate) line_start: usize,
     pub(crate) origin: Option<&'a str>,
     pub(crate) annotations: Vec<Annotation<'a>>,
     pub(crate) fold: bool,
 }
 
-impl<'a> Slice<'a> {
+impl<'a> Snippet<'a> {
     pub fn new(source: &'a str, line_start: usize) -> Self {
         Self {
             source,
@@ -162,7 +162,7 @@ pub enum Level {
     Help,
 }
 
-/// An annotation for a [`Slice`].
+/// An annotation for a [`Snippet`].
 ///
 /// This gets created by [`Label::span`].
 #[derive(Debug)]

tests/fixtures/deserialize.rs

@@ -1,7 +1,7 @@
 use serde::{Deserialize, Deserializer, Serialize};
 use std::ops::Range;
 
-use annotate_snippets::{renderer::Margin, Annotation, Label, Level, Message, Renderer, Slice};
+use annotate_snippets::{renderer::Margin, Annotation, Label, Level, Message, Renderer, Snippet};
 
 #[derive(Deserialize)]
 pub struct Fixture<'a> {
@@ -25,7 +25,7 @@ pub struct MessageDef<'a> {
     pub footer: Vec<Label<'a>>,
     #[serde(deserialize_with = "deserialize_slices")]
     #[serde(borrow)]
-    pub slices: Vec<Slice<'a>>,
+    pub slices: Vec<Snippet<'a>>,
 }
 
 impl<'a> From<MessageDef<'a>> for Message<'a> {
@@ -42,7 +42,7 @@ impl<'a> From<MessageDef<'a>> for Message<'a> {
         }
         snippet = slices
             .into_iter()
-            .fold(snippet, |snippet, slice| snippet.slice(slice));
+            .fold(snippet, |snippet, slice| snippet.snippet(slice));
         snippet = footer
             .into_iter()
             .fold(snippet, |snippet, label| snippet.footer(label));
@@ -81,23 +81,23 @@ where
         .collect())
 }
 
-fn deserialize_slices<'de, D>(deserializer: D) -> Result<Vec<Slice<'de>>, D::Error>
+fn deserialize_slices<'de, D>(deserializer: D) -> Result<Vec<Snippet<'de>>, D::Error>
 where
     D: Deserializer<'de>,
 {
     #[derive(Deserialize)]
     struct Wrapper<'a>(
-        #[serde(with = "SliceDef")]
+        #[serde(with = "SnippetDef")]
         #[serde(borrow)]
-        SliceDef<'a>,
+        SnippetDef<'a>,
     );
 
     let v = Vec::deserialize(deserializer)?;
     Ok(v.into_iter().map(|Wrapper(a)| a.into()).collect())
 }
 
 #[derive(Deserialize)]
-pub struct SliceDef<'a> {
+pub struct SnippetDef<'a> {
     #[serde(borrow)]
     pub source: &'a str,
     pub line_start: usize,
@@ -110,16 +110,16 @@ pub struct SliceDef<'a> {
     pub fold: bool,
 }
 
-impl<'a> From<SliceDef<'a>> for Slice<'a> {
-    fn from(val: SliceDef<'a>) -> Self {
-        let SliceDef {
+impl<'a> From<SnippetDef<'a>> for Snippet<'a> {
+    fn from(val: SnippetDef<'a>) -> Self {
+        let SnippetDef {
             source,
             line_start,
             origin,
             annotations,
             fold,
         } = val;
-        let mut slice = Slice::new(source, line_start).fold(fold);
+        let mut slice = Snippet::new(source, line_start).fold(fold);
         if let Some(origin) = origin {
             slice = slice.origin(origin)
         }