Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ All notable changes to this project will be documented in this file.
- `masterror::Error` now uses the in-tree derive, removing the dependency on
`thiserror` while keeping the same runtime behaviour and diagnostics.

## [0.5.6] - 2025-09-28

### Tests
- Added runtime coverage exercising every derive formatter variant (including
case-sensitive formatters) and asserted the rendered output.
- Added `trybuild` suites that compile successful formatter usage and verify the
emitted diagnostics for unsupported specifiers.

## [0.5.5] - 2025-09-27

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "masterror"
version = "0.5.5"
version = "0.5.6"
rust-version = "1.90"
edition = "2024"
license = "MIT OR Apache-2.0"
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Stable categories, conservative HTTP mapping, no `unsafe`.

~~~toml
[dependencies]
masterror = { version = "0.5.5", default-features = false }
masterror = { version = "0.5.6", default-features = false }
# or with features:
# masterror = { version = "0.5.5", features = [
# masterror = { version = "0.5.6", features = [
# "axum", "actix", "openapi", "serde_json",
# "sqlx", "sqlx-migrate", "reqwest", "redis",
# "validator", "config", "tokio", "multipart",
Expand Down Expand Up @@ -66,10 +66,10 @@ masterror = { version = "0.5.5", default-features = false }
~~~toml
[dependencies]
# lean core
masterror = { version = "0.5.5", default-features = false }
masterror = { version = "0.5.6", default-features = false }

# with Axum/Actix + JSON + integrations
# masterror = { version = "0.5.5", features = [
# masterror = { version = "0.5.6", features = [
# "axum", "actix", "openapi", "serde_json",
# "sqlx", "sqlx-migrate", "reqwest", "redis",
# "validator", "config", "tokio", "multipart",
Expand Down Expand Up @@ -262,13 +262,13 @@ assert_eq!(resp.status, 401);
Minimal core:

~~~toml
masterror = { version = "0.5.5", default-features = false }
masterror = { version = "0.5.6", default-features = false }
~~~

API (Axum + JSON + deps):

~~~toml
masterror = { version = "0.5.5", features = [
masterror = { version = "0.5.6", features = [
"axum", "serde_json", "openapi",
"sqlx", "reqwest", "redis", "validator", "config", "tokio"
] }
Expand All @@ -277,7 +277,7 @@ masterror = { version = "0.5.5", features = [
API (Actix + JSON + deps):

~~~toml
masterror = { version = "0.5.5", features = [
masterror = { version = "0.5.6", features = [
"actix", "serde_json", "openapi",
"sqlx", "reqwest", "redis", "validator", "config", "tokio"
] }
Expand Down
68 changes: 61 additions & 7 deletions tests/error_derive.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#![allow(unused_variables, non_shorthand_field_patterns)]

use std::error::Error as StdError;
#[cfg(error_generic_member_access)]
use std::ptr;
use std::{error::Error as StdError, fmt};

use masterror::Error;

Expand Down Expand Up @@ -152,16 +152,34 @@ enum EnumWithBacktrace {

#[derive(Debug, Error)]
#[error(
"x={value:x} X={value:X} #x={value:#x} #X={value:#X} b={value:b} #b={value:#b} \
o={value:o} #o={value:#o} e={float:e} #e={float:#e} E={float:E} #E={float:#E} \
p={ptr:p} #p={ptr:#p}"
"display={value} debug={value:?} #debug={value:#?} x={value:x} X={value:X} \
#x={value:#x} #X={value:#X} b={value:b} #b={value:#b} o={value:o} #o={value:#o} \
e={float:e} #e={float:#e} E={float:E} #E={float:#E} p={ptr:p} #p={ptr:#p}"
)]
struct FormatterShowcase {
value: u32,
float: f64,
ptr: *const u32
}

#[derive(Debug)]
struct PrettyDebugValue {
label: &'static str
}

impl fmt::Display for PrettyDebugValue {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.label)
}
}

#[derive(Debug, Error)]
#[error("display={value} debug={value:?} #debug={value:#?} tuple={tuple:?} #tuple={tuple:#?}")]
struct FormatterDebugShowcase {
value: PrettyDebugValue,
tuple: (&'static str, u8)
}

#[cfg(error_generic_member_access)]
fn assert_backtrace_interfaces<E>(error: &E, expected: &std::backtrace::Backtrace)
where
Expand Down Expand Up @@ -361,6 +379,34 @@ fn enum_backtrace_field_is_returned() {
}
}

#[test]
fn supports_display_and_debug_formatters() {
let value = PrettyDebugValue {
label: "Alpha"
};
let tuple = ("tuple", 7u8);

let expected = format!(
"display={value} debug={value:?} #debug={value:#?} tuple={tuple:?} #tuple={tuple:#?}",
);

let standard_debug = format!("{value:?}");
let alternate_debug = format!("{value:#?}");
assert_ne!(standard_debug, alternate_debug);

let tuple_debug = format!("{tuple:?}");
let tuple_alternate_debug = format!("{tuple:#?}");
assert_ne!(tuple_debug, tuple_alternate_debug);

let err = FormatterDebugShowcase {
value,
tuple
};

assert_eq!(err.to_string(), expected);
assert!(StdError::source(&err).is_none());
}

#[test]
fn supports_extended_formatters() {
let value = 0x5A5Au32;
Expand All @@ -374,11 +420,19 @@ fn supports_extended_formatters() {
};

let expected = format!(
"x={value:x} X={value:X} #x={value:#x} #X={value:#X} b={value:b} #b={value:#b} \
o={value:o} #o={value:#o} e={float:e} #e={float:#e} E={float:E} #E={float:#E} \
p={ptr:p} #p={ptr:#p}"
"display={value} debug={value:?} #debug={value:#?} x={value:x} X={value:X} \
#x={value:#x} #X={value:#X} b={value:b} #b={value:#b} o={value:o} #o={value:#o} \
e={float:e} #e={float:#e} E={float:E} #E={float:#E} p={ptr:p} #p={ptr:#p}"
);

let lower_hex = format!("{value:x}");
let upper_hex = format!("{value:X}");
assert_ne!(lower_hex, upper_hex);

let lower_exp = format!("{float:e}");
let upper_exp = format!("{float:E}");
assert_ne!(lower_exp, upper_exp);

assert_eq!(err.to_string(), expected);
assert!(StdError::source(&err).is_none());
}
12 changes: 12 additions & 0 deletions tests/error_derive_from_trybuild.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,15 @@ fn backtrace_attribute_compile_failures() {
let t = TestCases::new();
t.compile_fail("tests/ui/backtrace/*.rs");
}

#[test]
fn formatter_attribute_passes() {
let t = TestCases::new();
t.pass("tests/ui/formatter/pass/*.rs");
}

#[test]
fn formatter_attribute_compile_failures() {
let t = TestCases::new();
t.compile_fail("tests/ui/formatter/fail/*.rs");
}
9 changes: 9 additions & 0 deletions tests/ui/formatter/fail/unsupported_flag.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
use masterror::Error;

#[derive(Debug, Error)]
#[error("{value:##x}")]
struct UnsupportedFlag {
value: u32,
}

fn main() {}
11 changes: 11 additions & 0 deletions tests/ui/formatter/fail/unsupported_flag.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
error: placeholder spanning bytes 0..11 uses an unsupported formatter
--> tests/ui/formatter/fail/unsupported_flag.rs:4:9
|
4 | #[error("{value:##x}")]
| ^^^^^^^^^^^^^

error: missing #[error(...)] attribute
--> tests/ui/formatter/fail/unsupported_flag.rs:5:8
|
5 | struct UnsupportedFlag {
| ^^^^^^^^^^^^^^^
9 changes: 9 additions & 0 deletions tests/ui/formatter/fail/unsupported_formatter.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
use masterror::Error;

#[derive(Debug, Error)]
#[error("{value:y}")]
struct UnsupportedFormatter {
value: u32,
}

fn main() {}
11 changes: 11 additions & 0 deletions tests/ui/formatter/fail/unsupported_formatter.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
error: placeholder spanning bytes 0..9 uses an unsupported formatter
--> tests/ui/formatter/fail/unsupported_formatter.rs:4:9
|
4 | #[error("{value:y}")]
| ^^^^^^^^^^^

error: missing #[error(...)] attribute
--> tests/ui/formatter/fail/unsupported_formatter.rs:5:8
|
5 | struct UnsupportedFormatter {
| ^^^^^^^^^^^^^^^^^^^^
36 changes: 36 additions & 0 deletions tests/ui/formatter/pass/all_formatters.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
use masterror::Error;

#[derive(Debug, Error)]
#[error(
"display={pretty} debug={pretty:?} #debug={pretty:#?} x={value:x} X={value:X} \
#x={value:#x} #X={value:#X} b={value:b} #b={value:#b} o={value:o} #o={value:#o} \
e={float:e} #e={float:#e} E={float:E} #E={float:#E} p={ptr:p} #p={ptr:#p}"
)]
struct FormatterVariants {
value: u32,
float: f64,
ptr: *const u32,
pretty: PrettyDebugValue,
}

#[derive(Debug)]
struct PrettyDebugValue {
label: &'static str,
}

impl core::fmt::Display for PrettyDebugValue {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
f.write_str(self.label)
}
}

fn main() {
let showcase = FormatterVariants {
value: 0x5A5Au32,
float: 1234.5,
ptr: core::ptr::null(),
pretty: PrettyDebugValue { label: "alpha" },
};

let _ = showcase.to_string();
}
Loading