color-backtrace

Keeps rust-version from silently drifting out of date again.

• Restore Frame::is_dependency_code, accidentally removed in v0.7.3
  • It now simply forwards to default_is_dependency_frame
• Correct rust-version to 1.81
  • 1.81 has been the de-facto minimum since v0.7.1, which started using lint reasons; the manifest still claimed 1.70

• Support custom dependency filtering functions
  • New BacktracePrinter::dependency_predicate, IsDependencyCallback and default_is_dependency_frame
• Yanked: also removed Frame::is_dependency_code, breaking semver

• Fix dependency detection when running on Windows

Added

• Support for NO_COLOR and FORCE_COLOR environment variables for controlling color output
• New public function default_color_choice() to get color choice based on environment variables and terminal detection

Changed

• default_output_stream() now respects NO_COLOR and FORCE_COLOR environment variables

Remove gimli-symbolize crate feature

• Add Backtrace trait to abstract over backtrace implementation
• Changed Frame::ip type usize -> Option<usize>
• BacktracePrinter::print_trace now takes &dyn Backtrace instead of &backtrace::Backtrace
  • This may be API breaking when users use default-features = false so that &backtrace::Backtrace doesn't coerce to &dyn Backtrace
• Add experimental support for std::backtrace::Backtrace
  • Enable via { default-features = false, features = ["use-btparse-crate"] }
• Removed previously deprecated gimli-symbolize crate feature

• Publicly expose some helper methods on Frame type

• Replace unmaintained atty crate with std::io::IsTerminal
• Minimum supported Rust version raised to 1.70 (hence the bump to 0.6)

Update CHANGELOG, bump version

• Add the ability to print module_name:offset, or address of frame
  • Contributed by [@s1341], thanks!

• Add __rust_begin_short_backtrace filter
• Remove experimental failure support

Added

• Clone and Debug impls for BacktracePrinter
• COLORBT_SHOW_HIDDEN env variable, disabling frame filtering

Fixed

• Use correct verbosity level for string formatting
• Fix off-by-one in frame hiding code
  • Hides one additional post-panic frame
• Slightly improved doc

Added

• BacktracePrinter::format_trace_to_string
• Ability to add custom frame filter callbacks
  • BacktracePrinter::add_frame_filter
  • BacktracePrinter::clear_frame_filters
  • default_frame_filter
  • Thanks to [@yaahc] for helping out with this!
• Prefer RUST_LIB_BACKTRACE env var when determining the default verbosity to print non-panic backtraces
  • Also contributed by [@yaahc]

Changed

• Rename Settings → BacktracePrinter
• Move print_backtrace → BacktracePrinter::print_trace
• Move print_panic_info → BacktracePrinter::print_panic_info
• Move color_backtrace::failure::print_backtrace → BacktracePrinter::print_failure_trace
• The majority of old APIs have deprecated shims that forward calls to their new place to ease porting
• The out setting is no longer part of the BacktracePrinter and instead supplied as an argument to all functions that need it
  • The previous design forced Sync + Send + 'static constraints on any output stream since they are required when registering the panic handler, but are unnecessary when printing to strings
  • As a bonus, all format and print functions no longer require mutable access to the BacktracePrinter instance

Added

• Custom ColorScheme support
• Forward backtrace-rs' gimli-symbolize feature, which is default enabled
  • This is done by adding default-features = false to the Cargo.toml dependency entry for color-backtrace
  • Disabling it reduces transitive dependencies from ~50 → ~10
  • However, you'll pay for it with inaccurate source info on macOS and Linux

Changed

• Replace term crate for colorful term printing with termcolor
  • This crate is more actively maintained, has fewer deps and a better API
  • This made adding color scheme support very easy
• Settings::dim_function_hash_part was replaced
  • Hash part color is now controlled via ColorScheme

Removed

• Colorize, ColorizedStderrOutput, StreamOutput, PanicOutputStream
  • This functionality is now all provided by the termcolor crate
  • termcolor is re-exported in the root of color_backtrace
• Lots of transitive dependencies!

Changed

• Added post panic frame rules for [failure]
• Updated term dependency

Added

• Experimental support for [failure] error backtraces
  • Contributed by Jane Lusby ([@yaahc])

Changed

• Switch to [gimli] backend for backtraces on macOS and Linux
  • Fixes backtraces when invoking an app outside of its build directory
• Expose print_backtrace and print_panic_info functions

Changed

• Fixed panic then TERM env var is not found

Added

• This changelog!
• Customization via settings
• Printing to streams other than stderr

Changed

• Improved {dependency code,post panic frame,runtime init} heuristics
• Changed default panic message to be more professional
• Relicensed from MIT to MIT/Apache-2.0 dual licensing
• Moved get_verbosity → Verbosity::from_env
• Fix readability on light terminal themes
• Fix deadlock when unwrapping an error while printing the panic
• Many internal tweaks