fix!: Use explicit Range<usize>

BREAKING CHANGE: This changes (usize, usize) into Range<usize>

Author: Muscraft

benches/simple.rs

@@ -38,12 +38,12 @@ fn create_snippet(renderer: Renderer) {
                 SourceAnnotation {
                     label: "expected `Option<String>` because of return type",
                     annotation_type: AnnotationType::Warning,
-                    range: (5, 19),
+                    range: 5..19,
                 },
                 SourceAnnotation {
                     label: "expected enum `std::option::Option`",
                     annotation_type: AnnotationType::Error,
-                    range: (26, 724),
+                    range: 26..724,
                 },
             ],
         }],

examples/expected_type.rs

@@ -20,12 +20,12 @@ fn main() {
                 SourceAnnotation {
                     label: "",
                     annotation_type: AnnotationType::Error,
-                    range: (193, 195),
+                    range: 193..195,
                 },
                 SourceAnnotation {
                     label: "while parsing this struct",
                     annotation_type: AnnotationType::Info,
-                    range: (34, 50),
+                    range: 34..50,
                 },
             ],
         }],

examples/footer.rs

@@ -21,7 +21,7 @@ fn main() {
             fold: false,
             annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference",
-                range: (21, 24),
+                range: 21..24,
                 annotation_type: AnnotationType::Error,
             }],
         }],

examples/format.rs

@@ -32,12 +32,12 @@ fn main() {
                 SourceAnnotation {
                     label: "expected `Option<String>` because of return type",
                     annotation_type: AnnotationType::Warning,
-                    range: (5, 19),
+                    range: 5..19,
                 },
                 SourceAnnotation {
                     label: "expected enum `std::option::Option`",
                     annotation_type: AnnotationType::Error,
-                    range: (26, 724),
+                    range: 26..724,
                 },
             ],
         }],

src/renderer/display_list.rs

@@ -35,6 +35,7 @@ use crate::snippet;
 use itertools::FoldWhile::{Continue, Done};
 use itertools::Itertools;
 use std::fmt::{Display, Write};
+use std::ops::Range;
 use std::{cmp, fmt};
 
 use crate::renderer::{stylesheet::Stylesheet, Margin, Style};
@@ -768,7 +769,7 @@ fn format_slice(
     has_footer: bool,
     margin: Option<Margin>,
 ) -> Vec<DisplayLine<'_>> {
-    let main_range = slice.annotations.first().map(|x| x.range.0);
+    let main_range = slice.annotations.first().map(|x| x.range.start);
     let origin = slice.origin;
     let need_empty_header = origin.is_some() || is_first;
     let mut body = format_body(slice, need_empty_header, has_footer, margin);
@@ -951,8 +952,8 @@ fn format_body(
     let source_len = slice.source.len();
     if let Some(bigger) = slice.annotations.iter().find_map(|x| {
         // Allow highlighting one past the last character in the source.
-        if source_len + 1 < x.range.1 {
-            Some(x.range)
+        if source_len + 1 < x.range.end {
+            Some(&x.range)
         } else {
             None
         }
@@ -1017,8 +1018,8 @@ fn format_body(
                 _ => DisplayAnnotationType::from(annotation.annotation_type),
             };
             match annotation.range {
-                (start, _) if start > line_end_index => true,
-                (start, end)
+                Range { start, .. } if start > line_end_index => true,
+                Range { start, end }
                     if start >= line_start_index && end <= line_end_index
                         || start == line_end_index && end - start <= 1 =>
                 {
@@ -1047,7 +1048,7 @@ fn format_body(
                     annotation_line_count += 1;
                     false
                 }
-                (start, end)
+                Range { start, end }
                     if start >= line_start_index
                         && start <= line_end_index
                         && end > line_end_index =>
@@ -1091,7 +1092,7 @@ fn format_body(
                     }
                     true
                 }
-                (start, end) if start < line_start_index && end > line_end_index => {
+                Range { start, end } if start < line_start_index && end > line_end_index => {
                     if let DisplayLine::Source {
                         ref mut inline_marks,
                         ..
@@ -1106,7 +1107,7 @@ fn format_body(
                     }
                     true
                 }
-                (start, end)
+                Range { start, end }
                     if start < line_start_index
                         && end >= line_start_index
                         && end <= line_end_index =>
@@ -1375,7 +1376,7 @@ mod tests {
         let line_2 = "This is line 2";
         let source = [line_1, line_2].join("\n");
         // In line 2
-        let range = (22, 24);
+        let range = 22..24;
         let input = snippet::Snippet {
             title: None,
             footer: vec![],
@@ -1384,7 +1385,7 @@ mod tests {
                 line_start: 5402,
                 origin: None,
                 annotations: vec![snippet::SourceAnnotation {
-                    range,
+                    range: range.clone(),
                     label: "Test annotation",
                     annotation_type: snippet::AnnotationType::Info,
                 }],
@@ -1425,7 +1426,10 @@ mod tests {
                             style: DisplayTextStyle::Regular,
                         }],
                     },
-                    range: (range.0 - (line_1.len() + 1), range.1 - (line_1.len() + 1)),
+                    range: (
+                        range.start - (line_1.len() + 1),
+                        range.end - (line_1.len() + 1),
+                    ),
                     annotation_type: DisplayAnnotationType::Info,
                     annotation_part: DisplayAnnotationPart::Standalone,
                 },
@@ -1475,7 +1479,7 @@ mod tests {
             footer: vec![],
             slices: vec![snippet::Slice {
                 annotations: vec![snippet::SourceAnnotation {
-                    range: (0, source.len() + 2),
+                    range: 0..source.len() + 2,
                     label,
                     annotation_type: snippet::AnnotationType::Error,
                 }],
@@ -1502,7 +1506,7 @@ mod tests {
                 line_start: 1,
                 origin: Some("<current file>"),
                 annotations: vec![snippet::SourceAnnotation {
-                    range: (19, 23),
+                    range: 19..23,
                     label: "oops",
                     annotation_type: snippet::AnnotationType::Error,
                 }],

src/snippet.rs

@@ -31,6 +31,8 @@
 //! };
 //! ```
 
+use std::ops::Range;
+
 /// Primary structure provided for formatting
 #[derive(Debug, Default)]
 pub struct Snippet<'a> {
@@ -71,7 +73,7 @@ pub enum AnnotationType {
 #[derive(Debug)]
 pub struct SourceAnnotation<'a> {
     /// The byte range of the annotation in the `source` string
-    pub range: (usize, usize),
+    pub range: Range<usize>,
     pub label: &'a str,
     pub annotation_type: AnnotationType,
 }

tests/fixtures/deserialize.rs

@@ -1,4 +1,5 @@
 use serde::{Deserialize, Deserializer, Serialize};
+use std::ops::Range;
 
 use annotate_snippets::{
     renderer::Margin, Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation,
@@ -122,7 +123,7 @@ where
 #[derive(Serialize, Deserialize)]
 #[serde(remote = "SourceAnnotation")]
 pub struct SourceAnnotationDef<'a> {
-    pub range: (usize, usize),
+    pub range: Range<usize>,
     #[serde(borrow)]
     pub label: &'a str,
     #[serde(with = "AnnotationTypeDef")]

tests/formatter.rs

@@ -14,7 +14,7 @@ fn test_i_29() {
             line_start: 1,
             origin: Some("<current file>"),
             annotations: vec![SourceAnnotation {
-                range: (19, 23),
+                range: 19..23,
                 label: "oops",
                 annotation_type: AnnotationType::Error,
             }],
@@ -41,7 +41,7 @@ fn test_point_to_double_width_characters() {
             line_start: 1,
             origin: Some("<current file>"),
             annotations: vec![SourceAnnotation {
-                range: (12, 16),
+                range: 12..16,
                 label: "world",
                 annotation_type: AnnotationType::Error,
             }],
@@ -69,7 +69,7 @@ fn test_point_to_double_width_characters_across_lines() {
             line_start: 1,
             origin: Some("<current file>"),
             annotations: vec![SourceAnnotation {
-                range: (4, 15),
+                range: 4..15,
                 label: "Good morning",
                 annotation_type: AnnotationType::Error,
             }],
@@ -100,12 +100,12 @@ fn test_point_to_double_width_characters_multiple() {
             origin: Some("<current file>"),
             annotations: vec![
                 SourceAnnotation {
-                    range: (0, 6),
+                    range: 0..6,
                     label: "Sushi1",
                     annotation_type: AnnotationType::Error,
                 },
                 SourceAnnotation {
-                    range: (11, 15),
+                    range: 11..15,
                     label: "Sushi2",
                     annotation_type: AnnotationType::Note,
                 },
@@ -136,7 +136,7 @@ fn test_point_to_double_width_characters_mixed() {
             line_start: 1,
             origin: Some("<current file>"),
             annotations: vec![SourceAnnotation {
-                range: (12, 23),
+                range: 12..23,
                 label: "New world",
                 annotation_type: AnnotationType::Error,
             }],