Skip to content

Commit

Permalink
feat(source): Allow inner source type of a NamedSource to be borrowed (…
Browse files Browse the repository at this point in the history 
…#254)

BREAKING CHANGE: This makes the `NamedSource` type generic over its `Source` type, instead of boxing it.
  • Loading branch information
@erratic-pattern
erratic-pattern committed Feb 4, 2024
1 parent fad0e76 commit 1df3b1a
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 75 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ struct MyBad {
// The Source that we're gonna be printing snippets out of.
// This can be a String if you don't have or care about file names.
#[source_code]
src: NamedSource,
src: NamedSource<String>,
// Snippets and highlights can be included in the diagnostic!
#[label("This bit here")]
bad_bit: SourceSpan,
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
//! // The Source that we're gonna be printing snippets out of.
//! // This can be a String if you don't have or care about file names.
//! #[source_code]
//! src: NamedSource,
//! src: NamedSource<String>,
//! // Snippets and highlights can be included in the diagnostic!
//! #[label("This bit here")]
//! bad_bit: SourceSpan,
Expand Down
21 changes: 12 additions & 9 deletions src/named_source.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ use crate::{MietteError, MietteSpanContents, SourceCode, SpanContents};
/// Utility struct for when you have a regular [`SourceCode`] type that doesn't
/// implement `name`. For example [`String`]. Or if you want to override the
/// `name` returned by the `SourceCode`.
pub struct NamedSource {
source: Box<dyn SourceCode + 'static>,
pub struct NamedSource<S: SourceCode + 'static> {
source: S,
name: String,
}

impl std::fmt::Debug for NamedSource {
impl<S: SourceCode> std::fmt::Debug for NamedSource<S> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("NamedSource")
.field("name", &self.name)
Expand All @@ -17,12 +17,15 @@ impl std::fmt::Debug for NamedSource {
}
}

impl NamedSource {
impl<S: SourceCode + 'static> NamedSource<S> {
/// Create a new `NamedSource` using a regular [`SourceCode`] and giving
/// its returned [`SpanContents`] a name.
pub fn new(name: impl AsRef<str>, source: impl SourceCode + Send + Sync + 'static) -> Self {
pub fn new(name: impl AsRef<str>, source: S) -> Self
where
S: Send + Sync,
{
Self {
source: Box::new(source),
source,
name: name.as_ref().to_string(),
}
}
Expand All @@ -34,12 +37,12 @@ impl NamedSource {

/// Returns a reference the inner [`SourceCode`] type for this
/// `NamedSource`.
pub fn inner(&self) -> &(dyn SourceCode + 'static) {
&*self.source
pub fn inner(&self) -> &S {
&self.source
}
}

impl SourceCode for NamedSource {
impl<S: SourceCode + 'static> SourceCode for NamedSource<S> {
fn read_span<'a>(
&'a self,
span: &crate::SourceSpan,
Expand Down
56 changes: 28 additions & 28 deletions tests/graphical.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ fn empty_source() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -348,7 +348,7 @@ fn single_line_highlight_span_full_line() {
#[diagnostic(severity(Error))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<&'static str>,
#[label("This bit here")]
bad_bit: SourceSpan,
}
Expand Down Expand Up @@ -379,7 +379,7 @@ fn single_line_with_wide_char() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -416,7 +416,7 @@ fn single_line_with_two_tabs() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -455,7 +455,7 @@ fn single_line_with_tab_in_middle() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -494,7 +494,7 @@ fn single_line_highlight() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -566,7 +566,7 @@ fn single_line_highlight_offset_zero() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -602,7 +602,7 @@ fn single_line_highlight_offset_end_of_line() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -638,7 +638,7 @@ fn single_line_highlight_include_end_of_line() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -675,7 +675,7 @@ fn single_line_highlight_include_end_of_line_crlf() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -712,7 +712,7 @@ fn single_line_highlight_with_empty_span() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -749,7 +749,7 @@ fn single_line_highlight_no_label() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -785,7 +785,7 @@ fn single_line_highlight_at_line_start() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -910,7 +910,7 @@ fn multiple_same_line_highlights() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "x"]
highlight1: SourceSpan,
#[label = "y"]
Expand Down Expand Up @@ -955,7 +955,7 @@ fn multiple_same_line_highlights_with_tabs_in_middle() -> Result<(), MietteError
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "x"]
highlight1: SourceSpan,
#[label = "y"]
Expand Down Expand Up @@ -1002,7 +1002,7 @@ fn multiline_highlight_adjacent() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "these two lines"]
highlight: SourceSpan,
}
Expand Down Expand Up @@ -1075,7 +1075,7 @@ fn multiline_highlight_flyby() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "block 1"]
highlight1: SourceSpan,
#[label = "block 2"]
Expand Down Expand Up @@ -1126,7 +1126,7 @@ fn multiline_highlight_no_label() -> Result<(), MietteError> {
#[source]
source: Inner,
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "block 1"]
highlight1: SourceSpan,
#[label]
Expand Down Expand Up @@ -1190,7 +1190,7 @@ fn multiple_multiline_highlights_adjacent() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "this bit here"]
highlight1: SourceSpan,
#[label = "also this bit"]
Expand Down Expand Up @@ -1236,7 +1236,7 @@ fn multiple_multiline_highlights_overlapping_lines() -> Result<(), MietteError>
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "this bit here"]
highlight1: SourceSpan,
#[label = "also this bit"]
Expand Down Expand Up @@ -1264,7 +1264,7 @@ fn multiple_multiline_highlights_overlapping_offsets() -> Result<(), MietteError
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label = "this bit here"]
highlight1: SourceSpan,
#[label = "also this bit"]
Expand Down Expand Up @@ -1346,7 +1346,7 @@ fn related() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
#[related]
Expand Down Expand Up @@ -1402,7 +1402,7 @@ fn related_source_code_propagation() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
#[related]
Expand Down Expand Up @@ -1462,7 +1462,7 @@ fn related_severity() -> Result<(), MietteError> {
#[diagnostic(code(oops::my::bad), help("try doing it better next time?"))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
#[related]
Expand All @@ -1479,7 +1479,7 @@ fn related_severity() -> Result<(), MietteError> {
)]
Error {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
},
Expand All @@ -1492,7 +1492,7 @@ fn related_severity() -> Result<(), MietteError> {
)]
Warning {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
},
Expand All @@ -1505,7 +1505,7 @@ fn related_severity() -> Result<(), MietteError> {
)]
Advice {
#[source_code]
src: NamedSource,
src: NamedSource<String>,
#[label("this bit here")]
highlight: SourceSpan,
},
Expand Down Expand Up @@ -1588,7 +1588,7 @@ fn zero_length_eol_span() {
#[diagnostic(severity(Error))]
struct MyBad {
#[source_code]
src: NamedSource,
src: NamedSource<&'static str>,
#[label("This bit here")]
bad_bit: SourceSpan,
}
Expand Down

0 comments on commit 1df3b1a

Please sign in to comment.