Skip to content

Formatter for pretty panics and errors in Rust

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

rkuklik/terminator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

terminator

Rust library to provide fancy formatting for errors and backtraces. Based of and inspired by color-eyre. It is intended to be used in binary applications, not as error type in libraries.

Usage

To display pretty errors from your main function, you can just switch your error type to terminator::Terminator. However, to customise the appearance and behaviour of errors or to pretty print panics, set up your main function as below:

fn main() -> Result<(), terminator::Terminator> {
    terminator::Config::new()
        // modify config if you so wish
        // and install config (setting up panic hook)
        .install()?;

    Ok(())
}

Feature flags

Terminator can bundle support for common error trait object libraries like anyhow and eyre. Setting respective flags will enable conversions and ? operator for Terminator. By default, Terminator is backed by Box<dyn Error>.

Following flags are provided:

  • anyhow: use anyhow::Error as backend for Terminator (conflicts with eyre feature)
  • eyre: use eyre::Report as backend for Terminator (conflicts with anyhow feature)
  • compat: enable Compat struct as bridge between eyre and anyhow if both are used

About

Formatter for pretty panics and errors in Rust

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published