feat!(blanket_impls): impl Diagnostic for &T and Box<T>#367
Open
TheLostLambda wants to merge 1 commit into
Open
feat!(blanket_impls): impl Diagnostic for &T and Box<T>#367TheLostLambda wants to merge 1 commit into
Diagnostic for &T and Box<T>#367TheLostLambda wants to merge 1 commit into
Conversation
Brings things in line with best practices as described in "Rust for Rustaceans" when it comes to "Ergonomic Trait Implementations" in Chapter 3. Practically means that people can pass more types to any functions taking either `dyn Diagnostic` or `impl Diagnostic`. BREAKING CHANGE: Added blanket impls may overlap with manual user impls. If these impls are just hacks to achieve the same as the blanket ones do, then they can simply be removed. If the impls for `T` and `&T` differ semantically, then the user would need to employ the newtype pattern to avoid overlap.
Contributor
Author
|
Uh oh, this make have broken more than I thought... Let's hold off for the moment 😅 EDIT: I think it's fine... Turns out typoing |
Contributor
Author
|
Confirmed to be working well for me! This let me go from: use miette::Diagnostic;
use std::fmt::Debug;
pub trait UnwrapDiagnostic<E> {
fn unwrap_diagnostic(self) -> E;
}
impl<T: Debug, E: Diagnostic> UnwrapDiagnostic<E> for Result<T, E> {
fn unwrap_diagnostic(self) -> E {
self.unwrap_err()
}
}
impl<T: Debug, E: Diagnostic> UnwrapDiagnostic<E> for Result<T, Box<E>> {
fn unwrap_diagnostic(self) -> E {
*self.unwrap_err()
}
}
macro_rules! assert_miette_snapshot {
($diag:expr) => {{
use insta::{with_settings, assert_snapshot};
use miette::{GraphicalReportHandler, GraphicalTheme};
use crate::testing_tools::UnwrapDiagnostic;
let mut out = String::new();
GraphicalReportHandler::new_themed(GraphicalTheme::unicode_nocolor())
.with_width(80)
.render_report(&mut out, &$diag.unwrap_diagnostic())
.unwrap();
with_settings!({
description => stringify!($diag)
}, {
assert_snapshot!(out);
});
}};
}
pub(crate) use assert_miette_snapshot;To just: macro_rules! assert_miette_snapshot {
($diag:expr) => {{
use insta::{with_settings, assert_snapshot};
use miette::{GraphicalReportHandler, GraphicalTheme};
let mut out = String::new();
GraphicalReportHandler::new_themed(GraphicalTheme::unicode_nocolor())
.with_width(80)
.render_report(&mut out, &$diag.unwrap_err())
.unwrap();
with_settings!({
description => stringify!($diag)
}, {
assert_snapshot!(out);
});
}};
}
pub(crate) use assert_miette_snapshot; |
This was referenced Apr 26, 2025
|
I'm encountering a similar issue to #431. What's the recommended workaround while waiting for this PR to be merged? |
azzamsa
added a commit
to azzamsa/gelatyx
that referenced
this pull request
Jun 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Partially addresses #366
Brings things in line with best practices as described in "Rust for Rustaceans" when it comes to "Ergonomic Trait Implementations" in Chapter 3. Practically means that people can pass more types to any functions taking either
dyn Diagnosticorimpl Diagnostic.BREAKING CHANGE: Added blanket impls may overlap with manual user impls. If these impls are just hacks to achieve the same as the blanket ones do, then they can simply be removed. If the impls for
Tand&Tdiffer semantically, then the user would need to employ the newtype pattern to avoid overlap.