Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom Debug impl for DispatchError #1153

Merged
merged 6 commits into from
Sep 11, 2023
Merged

Custom Debug impl for DispatchError #1153

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bf49ca4
Custom `Debug` impl for `DispatchError`
ascjones Sep 7, 2023
74139cd
Implement suggestion
ascjones Sep 7, 2023
3351b98
Display bytes if details cannot be resolved
ascjones Sep 7, 2023
eace8e7
Merge branch 'master' into aj/module-err-debug
ascjones Sep 11, 2023
fff6252
Extract fn and use from Display impl
ascjones Sep 11, 2023
2fdd081
Display just shows {details}
ascjones Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion subxt/src/error/dispatch_error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ pub enum TransactionalError {
}

/// Details about a module error that has occurred.
#[derive(Clone, Debug, thiserror::Error)]
#[derive(Clone, thiserror::Error)]
#[non_exhaustive]
pub struct ModuleError {
metadata: Metadata,
Expand All @@ -142,6 +142,22 @@ impl PartialEq for ModuleError {

impl Eq for ModuleError {}

/// Custom `Debug` implementation, ignores the very large `metadata` field, using it instead (as
/// intended) to resolve the actual pallet and error names. This is much more useful for debugging.
impl Debug for ModuleError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Ok(details) = self.details() else {
return f
.write_str("Unknown pallet error (pallet and error details cannot be retrieved)");
};
f.debug_struct("ModuleError")
.field("bytes", &self.bytes)
.field("pallet", &details.pallet.name())
.field("error", &details.variant.name)
.finish()
}
}

impl std::fmt::Display for ModuleError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Ok(details) = self.details() else {
Expand Down