Struct StackReport 

pub struct StackReport<E>(/* private fields */);

Formats a StackError chain as a stack-trace-like report with type names and locations.

Wraps Result<(), E> and provides formatted output via Display (and Debug, which delegates to Display). Used at error display boundaries such as main().

Create via StackReport::from(error), Result::<(), E>::into(), or error.into().

Output Format

Error: AppError::IoFailed: io failed, at src/main.rs:42:5
Caused by (recent first):
  1| InfraError::Read: read failed, at src/infra.rs:10:9
  2| No such file or directory (os error 2)

The first line shows the top-level error with type name and location. StackError sources (with location) are listed first with numbering, then plain Error::source() chain entries (without location) follow.

With the std feature, implements Termination for use as the return type of main(). The #[suzunari_error::report] macro can transform fn() -> Result<(), E> into fn() -> StackReport<E> automatically.

Example

use suzunari_error::*;

#[suzunari_error]
#[suzu(display("app error"))]
struct AppError {
    source: std::io::Error,
}

fn run() -> Result<(), AppError> {
    std::fs::read("/nonexistent").context(AppSnafu)?;
    Ok(())
}

let err = run().unwrap_err();
let report = StackReport::from(err);

let output = format!("{report}");
assert!(output.contains("Error: AppError: app error"));
assert!(output.contains("Caused by"));

Notes

• Both Display and Debug produce an empty string for the Ok case. This is intentional — in the Termination use case, success should be silent.
• Debug delegates to Display (same output). This intentionally deviates from the C-DEBUG guideline because Termination calls Debug::fmt to produce the error output. Making Debug structural (e.g., StackReport(Err(...))) would render the terminal output useless. Since StackReport is a display boundary type (not a general-purpose data carrier), the human-readable format is appropriate for both traits.
• Display output does not include a trailing newline. This matches the convention for Display implementations and avoids double newlines with eprintln!("{report}"). The Termination impl adds a trailing newline when writing to stderr.

Trait Implementations

impl<E: StackError> Debug for StackReport<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: StackError> Display for StackReport<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: StackError> From<E> for StackReport<E>

fn from(error: E) -> Self

Converts to this type from the input type.

impl<E: StackError> From<Result<(), E>> for StackReport<E>

fn from(result: Result<(), E>) -> Self

Converts to this type from the input type.

impl<E: StackError> Termination for StackReport<E>

Available on crate feature std only.

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.