use core::{
error::Error,
fmt,
};
#[cfg(feature = "std")]
use std::backtrace::BacktraceStatus;
use crate::errors::BunsenError;
pub struct Report<'a> {
error: &'a BunsenError,
}
impl<'a> Report<'a> {
pub(crate) fn new(error: &'a BunsenError) -> Self {
Self { error }
}
}
fn write_details(
f: &mut fmt::Formatter<'_>,
details: &str,
) -> fmt::Result {
for line in details.lines() {
if line.is_empty() {
writeln!(f)?;
write!(f, " |")?;
} else {
writeln!(f)?;
write!(f, " | {line}")?;
}
}
Ok(())
}
impl fmt::Display for Report<'_> {
fn fmt(
&self,
f: &mut fmt::Formatter<'_>,
) -> fmt::Result {
let e = self.error;
write!(f, "error[{}]: {}", e.kind(), e.message())?;
writeln!(f)?;
write!(f, " at {}", e.location())?;
if let Some(details) = e.details() {
write_details(f, details)?;
}
for remark in e.remarks() {
writeln!(f)?;
write!(
f,
" re-marked {} -> {} at {}",
remark.from(),
remark.to(),
remark.location()
)?;
}
for frame in e.frames() {
writeln!(f)?;
write!(f, " while {} ({})", frame.message(), frame.location())?;
if let Some(details) = frame.details() {
write_details(f, details)?;
}
}
let mut source = e.source();
while let Some(cause) = source {
writeln!(f)?;
write!(f, "caused by: {cause}")?;
source = cause.source();
}
#[cfg(feature = "std")]
if let Some(backtrace) = e.backtrace()
&& backtrace.status() == BacktraceStatus::Captured
{
writeln!(f)?;
write!(f, "backtrace:\n{backtrace}")?;
}
Ok(())
}
}
impl fmt::Debug for Report<'_> {
fn fmt(
&self,
f: &mut fmt::Formatter<'_>,
) -> fmt::Result {
fmt::Display::fmt(self, f)
}
}
#[cfg(test)]
mod tests {
use alloc::format;
use super::*;
use crate::errors::BunsenErrorKind;
#[test]
fn test_report_layout() {
let e = BunsenError::illegal("stride is zero")
.with_details("stride: 0\nkernel: 3")
.context("building block 3")
.context_details("building the stem", "blocks: 4")
.as_policy();
let report = format!("{}", e.report());
let lines: alloc::vec::Vec<&str> = report.lines().collect();
assert_eq!(lines[0], "error[Policy]: stride is zero");
assert!(lines[1].starts_with(" at "), "{report}");
assert_eq!(lines[2], " | stride: 0");
assert_eq!(lines[3], " | kernel: 3");
assert!(
lines[4].starts_with(" re-marked Illegal -> Policy at "),
"{report}"
);
assert!(
lines[5].starts_with(" while building block 3 ("),
"{report}"
);
assert!(
lines[6].starts_with(" while building the stem ("),
"{report}"
);
assert_eq!(lines[7], " | blocks: 4");
assert_eq!(format!("{e:#}"), report);
assert_eq!(format!("{e:?}"), report);
assert_eq!(e.kind(), BunsenErrorKind::Policy);
}
}