diff --git a/README.md b/README.md index 0a1bcde..661ce31 100644 --- a/README.md +++ b/README.md @@ -1,110 +1 @@ -color-spantrace -=============== - -[![Build Status][actions-badge]][actions-url] -[![Latest Version](https://img.shields.io/crates/v/color-spantrace.svg)](https://crates.io/crates/color-spantrace) -[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/color-spantrace) - -[actions-badge]: https://github.com/yaahc/color-spantrace/workflows/Continuous%20integration/badge.svg -[actions-url]: https://github.com/yaahc/color-spantrace/actions?query=workflow%3A%22Continuous+integration%22 - -A rust library for colorizing [`tracing_error::SpanTrace`] objects in the style -of [`color-backtrace`]. - -## Setup - -Add the following to your `Cargo.toml`: - -```toml -[dependencies] -color-spantrace = "0.2" -tracing = "0.1" -tracing-error = "0.2" -tracing-subscriber = "0.3" -``` - -Setup a tracing subscriber with an `ErrorLayer`: - -```rust -use tracing_error::ErrorLayer; -use tracing_subscriber::{prelude::*, registry::Registry}; - -Registry::default().with(ErrorLayer::default()).init(); -``` - -Create spans and enter them: - -```rust -use tracing::instrument; -use tracing_error::SpanTrace; - -#[instrument] -fn foo() -> SpanTrace { - SpanTrace::capture() -} -``` - -And finally colorize the `SpanTrace`: - -```rust -use tracing_error::SpanTrace; - -let span_trace = SpanTrace::capture(); -println!("{}", color_spantrace::colorize(&span_trace)); -``` - -## Example - -This example is taken from `examples/usage.rs`: - -```rust -use tracing::instrument; -use tracing_error::{ErrorLayer, SpanTrace}; -use tracing_subscriber::{prelude::*, registry::Registry}; - -#[instrument] -fn main() { - Registry::default().with(ErrorLayer::default()).init(); - - let span_trace = one(42); - println!("{}", color_spantrace::colorize(&span_trace)); -} - -#[instrument] -fn one(i: u32) -> SpanTrace { - two() -} - -#[instrument] -fn two() -> SpanTrace { - SpanTrace::capture() -} -``` - -This creates the following output - -### Minimal Format - -![minimal format](./pictures/minimal.png) - -### Full Format - -![Full format](./pictures/full.png) - -#### License - - -Licensed under either of Apache License, Version -2.0 or MIT license at your option. - - -
- - -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in this crate by you, as defined in the Apache-2.0 license, shall -be dual licensed as above, without any additional terms or conditions. - - -[`tracing_error::SpanTrace`]: https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html -[`color-backtrace`]: https://github.com/athre0z/color-backtrace +#### The code has been moved into a monorepo at https://github.com/eyre-rs/eyre/tree/master/color-spantrace diff --git a/src/lib.rs b/src/lib.rs index 3a7e45f..8b70488 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -67,7 +67,6 @@ rust_2018_idioms, unreachable_pub, bad_style, - const_err, dead_code, improper_ctypes, non_shorthand_field_patterns, @@ -75,7 +74,6 @@ overflowing_literals, path_statements, patterns_in_fns_without_body, - private_in_public, unconditional_recursion, unused, unused_allocation,