mirror of
https://github.com/eyre-rs/eyre.git
synced 2025-09-28 05:21:34 +00:00
Add color-eyre to workspace
This commit is contained in:
Pavan Kumar Sunkara
parent
59938211cc
commit
7c7079ed6e
9
.github/workflows/ci.yml
vendored
9
.github/workflows/ci.yml
vendored
@ -44,9 +44,9 @@ jobs:
|
||||
features:
|
||||
- # default
|
||||
- --no-default-features
|
||||
- --features track-caller
|
||||
- --no-default-features --features track-caller
|
||||
- --no-default-features --features auto-install
|
||||
- --features pyo3
|
||||
- --features auto-install
|
||||
- --all-features
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
@ -67,8 +67,8 @@ jobs:
|
||||
features:
|
||||
- # default
|
||||
- --no-default-features
|
||||
- --features track-caller
|
||||
- --features auto-install
|
||||
- --no-default-features --features track-caller
|
||||
- --no-default-features --features auto-install
|
||||
# skip `--features pyo3` and `--all-features` because pyo3 doesn't support this msrv
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
@ -136,6 +136,7 @@ jobs:
|
||||
with:
|
||||
command: clippy
|
||||
args: --all-targets --all-features -- -D warnings
|
||||
|
||||
miri:
|
||||
name: Miri
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
[workspace]
|
||||
members = [
|
||||
"color-eyre",
|
||||
"color-spantrace",
|
||||
"eyre"
|
||||
]
|
||||
@ -15,3 +16,4 @@ rust-version = "1.65.0"
|
||||
[workspace.dependencies]
|
||||
indenter = "0.3.0"
|
||||
once_cell = "1.18.0"
|
||||
owo-colors = "3.2.0"
|
||||
15
README.md
15
README.md
@ -1,13 +1,16 @@
|
||||
eyre
|
||||
====
|
||||
# eyre
|
||||
|
||||
[![Build Status][actions-badge]][actions-url]
|
||||
[](https://crates.io/crates/eyre)
|
||||
[](https://docs.rs/eyre)
|
||||
[![Latest Version][version-badge]][version-url]
|
||||
[![Rust Documentation][docs-badge]][docs-url]
|
||||
[![Discord chat][discord-badge]][discord-url]
|
||||
|
||||
[actions-badge]: https://github.com/eyre-rs/eyre/workflows/Continuous%20integration/badge.svg
|
||||
[actions-url]: https://github.com/eyre-rs/eyre/actions?query=workflow%3A%22Continuous+integration%22
|
||||
[version-badge]: https://img.shields.io/crates/v/eyre.svg
|
||||
[version-url]: https://crates.io/crates/eyre
|
||||
[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg
|
||||
[docs-url]: https://docs.rs/eyre
|
||||
[discord-badge]: https://img.shields.io/discord/960645145018110012?label=eyre%20community%20discord
|
||||
[discord-url]: https://discord.gg/z94RqmUTKB
|
||||
|
||||
@ -253,10 +256,10 @@ implements `context` for options which you can import to make existing
|
||||
[`anyhow`]: https://github.com/dtolnay/anyhow
|
||||
[`tracing_error::SpanTrace`]: https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html
|
||||
[`stable-eyre`]: https://github.com/eyre-rs/stable-eyre
|
||||
[`color-eyre`]: https://github.com/eyre-rs/color-eyre
|
||||
[`color-eyre`]: https://github.com/eyre-rs/eyre/tree/master/color-eyre
|
||||
[`jane-eyre`]: https://github.com/yaahc/jane-eyre
|
||||
[`simple-eyre`]: https://github.com/eyre-rs/simple-eyre
|
||||
[`color-spantrace`]: https://github.com/eyre-rs/color-spantrace
|
||||
[`color-spantrace`]: https://github.com/eyre-rs/eyre/tree/master/color-spantrace
|
||||
[`color-backtrace`]: https://github.com/athre0z/color-backtrace
|
||||
|
||||
[^1]: example and explanation of breakage https://github.com/eyre-rs/eyre/issues/30#issuecomment-647650361
|
||||
|
||||
3
color-eyre/.gitignore
vendored
3
color-eyre/.gitignore
vendored
@ -1,3 +0,0 @@
|
||||
/target
|
||||
Cargo.lock
|
||||
.vscode/
|
||||
@ -72,17 +72,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
better compatibility with the Display trait
|
||||
|
||||
<!-- next-url -->
|
||||
[Unreleased]: https://github.com/yaahc/color-eyre/compare/v0.6.2...HEAD
|
||||
[0.6.2]: https://github.com/yaahc/color-eyre/compare/v0.6.1...v0.6.2
|
||||
[0.6.1]: https://github.com/yaahc/color-eyre/compare/v0.6.0...v0.6.1
|
||||
[0.6.0]: https://github.com/yaahc/color-eyre/compare/v0.5.11...v0.6.0
|
||||
[0.5.11]: https://github.com/yaahc/color-eyre/compare/v0.5.10...v0.5.11
|
||||
[0.5.10]: https://github.com/yaahc/color-eyre/compare/v0.5.9...v0.5.10
|
||||
[0.5.9]: https://github.com/yaahc/color-eyre/compare/v0.5.8...v0.5.9
|
||||
[0.5.8]: https://github.com/yaahc/color-eyre/compare/v0.5.7...v0.5.8
|
||||
[0.5.7]: https://github.com/yaahc/color-eyre/compare/v0.5.6...v0.5.7
|
||||
[0.5.6]: https://github.com/yaahc/color-eyre/compare/v0.5.5...v0.5.6
|
||||
[0.5.5]: https://github.com/yaahc/color-eyre/compare/v0.5.4...v0.5.5
|
||||
[0.5.4]: https://github.com/yaahc/color-eyre/compare/v0.5.3...v0.5.4
|
||||
[0.5.3]: https://github.com/yaahc/color-eyre/compare/v0.5.2...v0.5.3
|
||||
[0.5.2]: https://github.com/yaahc/color-eyre/releases/tag/v0.5.2
|
||||
[Unreleased]: https://github.com/eyre-rs/color-eyre/compare/v0.6.2...HEAD
|
||||
[0.6.2]: https://github.com/eyre-rs/color-eyre/compare/v0.6.1...v0.6.2
|
||||
[0.6.1]: https://github.com/eyre-rs/color-eyre/compare/v0.6.0...v0.6.1
|
||||
[0.6.0]: https://github.com/eyre-rs/color-eyre/compare/v0.5.11...v0.6.0
|
||||
[0.5.11]: https://github.com/eyre-rs/color-eyre/compare/v0.5.10...v0.5.11
|
||||
[0.5.10]: https://github.com/eyre-rs/color-eyre/compare/v0.5.9...v0.5.10
|
||||
[0.5.9]: https://github.com/eyre-rs/color-eyre/compare/v0.5.8...v0.5.9
|
||||
[0.5.8]: https://github.com/eyre-rs/color-eyre/compare/v0.5.7...v0.5.8
|
||||
[0.5.7]: https://github.com/eyre-rs/color-eyre/compare/v0.5.6...v0.5.7
|
||||
[0.5.6]: https://github.com/eyre-rs/color-eyre/compare/v0.5.5...v0.5.6
|
||||
[0.5.5]: https://github.com/eyre-rs/color-eyre/compare/v0.5.4...v0.5.5
|
||||
[0.5.4]: https://github.com/eyre-rs/color-eyre/compare/v0.5.3...v0.5.4
|
||||
[0.5.3]: https://github.com/eyre-rs/color-eyre/compare/v0.5.2...v0.5.3
|
||||
[0.5.2]: https://github.com/eyre-rs/color-eyre/releases/tag/v0.5.2
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
[package]
|
||||
name = "color-eyre"
|
||||
version = "0.6.2"
|
||||
authors = ["Jane Lusby <jlusby@yaah.dev>"]
|
||||
edition = "2018"
|
||||
license = "MIT OR Apache-2.0"
|
||||
description = "An error report handler for panics and eyre::Reports for colorful, consistent, and well formatted error reports for all kinds of errors."
|
||||
repository = "https://github.com/yaahc/color-eyre"
|
||||
documentation = "https://docs.rs/color-eyre"
|
||||
readme = "README.md"
|
||||
categories = []
|
||||
keywords = []
|
||||
|
||||
authors = { workspace = true }
|
||||
edition = { workspace = true }
|
||||
license = { workspace = true }
|
||||
repository = { workspace = true }
|
||||
readme = { workspace = true }
|
||||
rust-version = { workspace = true }
|
||||
|
||||
[features]
|
||||
default = ["track-caller", "capture-spantrace"]
|
||||
@ -21,10 +21,10 @@ track-caller = []
|
||||
eyre = "0.6.1"
|
||||
tracing-error = { version = "0.2.0", optional = true }
|
||||
backtrace = { version = "0.3.48", features = ["gimli-symbolize"] }
|
||||
indenter = "0.3.0"
|
||||
owo-colors = "3.2.0"
|
||||
indenter = { workspace = true }
|
||||
owo-colors = { workspace = true }
|
||||
color-spantrace = { version = "0.2", optional = true }
|
||||
once_cell = "1.4.0"
|
||||
once_cell = { workspace = true }
|
||||
url = { version = "2.1.1", optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
@ -78,5 +78,5 @@ exactly=1
|
||||
[[package.metadata.release.pre-release-replacements]]
|
||||
file="CHANGELOG.md"
|
||||
search="<!-- next-url -->"
|
||||
replace="<!-- next-url -->\n[Unreleased]: https://github.com/yaahc/{{crate_name}}/compare/{{tag_name}}...HEAD"
|
||||
replace="<!-- next-url -->\n[Unreleased]: https://github.com/eyre-rs/{{crate_name}}/compare/{{tag_name}}...HEAD"
|
||||
exactly=1
|
||||
|
||||
@ -1,201 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
1
color-eyre/LICENSE-APACHE
Symbolic link
1
color-eyre/LICENSE-APACHE
Symbolic link
@ -0,0 +1 @@
|
||||
../LICENSE-APACHE
|
||||
@ -1,23 +0,0 @@
|
||||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
1
color-eyre/LICENSE-MIT
Symbolic link
1
color-eyre/LICENSE-MIT
Symbolic link
@ -0,0 +1 @@
|
||||
../LICENSE-MIT
|
||||
@ -1,11 +1,11 @@
|
||||
## color-eyre
|
||||
# color-eyre
|
||||
|
||||
[![Build Status][actions-badge]][actions-url]
|
||||
[![Latest Version][version-badge]][version-url]
|
||||
[![Rust Documentation][docs-badge]][docs-url]
|
||||
|
||||
[actions-badge]: https://github.com/yaahc/color-eyre/workflows/Continuous%20integration/badge.svg
|
||||
[actions-url]: https://github.com/yaahc/color-eyre/actions?query=workflow%3A%22Continuous+integration%22
|
||||
[actions-badge]: https://github.com/eyre-rs/eyre/workflows/Continuous%20integration/badge.svg
|
||||
[actions-url]: https://github.com/eyre-rs/eyre/actions?query=workflow%3A%22Continuous+integration%22
|
||||
[version-badge]: https://img.shields.io/crates/v/color-eyre.svg
|
||||
[version-url]: https://crates.io/crates/color-eyre
|
||||
[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg
|
||||
@ -18,7 +18,7 @@ formatted error reports for all kinds of errors.
|
||||
|
||||
`color_eyre` helps you build error reports that look like this:
|
||||
|
||||
|
||||
|
||||
|
||||
## Setup
|
||||
|
||||
@ -104,14 +104,14 @@ and `Backtrace`, minimal, short, and full. Take the below snippets of the output
|
||||
Running `cargo run --example usage` without `RUST_LIB_BACKTRACE` set will produce a minimal
|
||||
report like this:
|
||||
|
||||
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
Running `RUST_LIB_BACKTRACE=1 cargo run --example usage` tells `color-eyre` to use the short
|
||||
format, which additionally capture a [`backtrace::Backtrace`]:
|
||||
|
||||
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
@ -119,7 +119,7 @@ Finally, running `RUST_LIB_BACKTRACE=full cargo run --example usage` tells `colo
|
||||
the full format, which in addition to the above will attempt to include source lines where the
|
||||
error originated from, assuming it can find them on the disk.
|
||||
|
||||
|
||||
|
||||
|
||||
### Custom `Section`s for error reports via [`Section`] trait
|
||||
|
||||
@ -166,7 +166,7 @@ one for `stderr`.
|
||||
Running `cargo run --example custom_section` shows us how these sections are
|
||||
included in the output:
|
||||
|
||||
|
||||
|
||||
|
||||
Only the `Stderr:` section actually gets included. The `cat` command fails,
|
||||
so stdout ends up being empty and is skipped in the final report. This gives
|
||||
@ -205,15 +205,15 @@ For an example of how to setup custom filters, check out [`examples/custom_filte
|
||||
[`eyre::EyreHandler`]: https://docs.rs/eyre/*/eyre/trait.EyreHandler.html
|
||||
[`backtrace::Backtrace`]: https://docs.rs/backtrace/*/backtrace/struct.Backtrace.html
|
||||
[`tracing_error::SpanTrace`]: https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html
|
||||
[`color-spantrace`]: https://github.com/yaahc/color-spantrace
|
||||
[`color-spantrace`]: https://github.com/eyre-rs/eyre/tree/master/color-spantrace
|
||||
[`Section`]: https://docs.rs/color-eyre/*/color_eyre/section/trait.Section.html
|
||||
[`eyre::Report`]: https://docs.rs/eyre/*/eyre/struct.Report.html
|
||||
[`eyre::Result`]: https://docs.rs/eyre/*/eyre/type.Result.html
|
||||
[`Handler`]: https://docs.rs/color-eyre/*/color_eyre/struct.Handler.html
|
||||
[`examples/usage.rs`]: https://github.com/yaahc/color-eyre/blob/master/examples/usage.rs
|
||||
[`examples/custom_filter.rs`]: https://github.com/yaahc/color-eyre/blob/master/examples/custom_filter.rs
|
||||
[`examples/custom_section.rs`]: https://github.com/yaahc/color-eyre/blob/master/examples/custom_section.rs
|
||||
[`examples/multiple_errors.rs`]: https://github.com/yaahc/color-eyre/blob/master/examples/multiple_errors.rs
|
||||
[`examples/usage.rs`]: https://github.com/eyre-rs/color-eyre/blob/master/examples/usage.rs
|
||||
[`examples/custom_filter.rs`]: https://github.com/eyre-rs/eyre/tree/master/color-eyre/blob/master/examples/custom_filter.rs
|
||||
[`examples/custom_section.rs`]: https://github.com/eyre-rs/eyre/tree/master/color-eyre/blob/master/examples/custom_section.rs
|
||||
[`examples/multiple_errors.rs`]: https://github.com/eyre-rs/eyre/tree/master/color-eyre/blob/master/examples/multiple_errors.rs
|
||||
|
||||
#### License
|
||||
|
||||
|
||||
@ -23,7 +23,8 @@ fn get_error(msg: &'static str) -> Report {
|
||||
.error(TestError("error"))
|
||||
}
|
||||
|
||||
// Using `Option` to add dependency code. See https://github.com/yaahc/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
// Using `Option` to add dependency code.
|
||||
// See https://github.com/eyre-rs/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
None::<Option<()>>
|
||||
.ok_or_else(|| create_report(msg))
|
||||
.unwrap_err()
|
||||
|
||||
@ -24,7 +24,8 @@ fn get_error(msg: &'static str) -> Report {
|
||||
.error(TestError("error"))
|
||||
}
|
||||
|
||||
// Getting regular `Report`. Using `Option` to trigger `is_dependency_code`. See https://github.com/yaahc/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
// Getting regular `Report`. Using `Option` to trigger `is_dependency_code`.
|
||||
// See https://github.com/eyre-rs/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
None::<Option<()>>.ok_or_else(|| create_report(msg)).unwrap_err()
|
||||
}
|
||||
|
||||
|
||||
@ -493,7 +493,7 @@ impl HookBuilder {
|
||||
///
|
||||
/// ```rust
|
||||
/// color_eyre::config::HookBuilder::default()
|
||||
/// .panic_section("consider reporting the bug at https://github.com/yaahc/color-eyre")
|
||||
/// .panic_section("consider reporting the bug at https://github.com/eyre-rs/eyre")
|
||||
/// .install()
|
||||
/// .unwrap()
|
||||
/// ```
|
||||
|
||||
@ -21,7 +21,8 @@ fn get_error(msg: &'static str) -> Report {
|
||||
.error(TestError("error"))
|
||||
}
|
||||
|
||||
// Using `Option` to trigger `is_dependency_code`. See https://github.com/yaahc/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
// Using `Option` to trigger `is_dependency_code`.
|
||||
// See https://github.com/eyre-rs/color-eyre/blob/4ddaeb2126ed8b14e4e6aa03d7eef49eb8561cf0/src/config.rs#L56
|
||||
None::<Option<()>>.ok_or_else(|| create_report(msg)).unwrap_err()
|
||||
}
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ rust-version = { workspace = true }
|
||||
[dependencies]
|
||||
tracing-error = "0.2.0"
|
||||
tracing-core = "0.1.21"
|
||||
owo-colors = "3.2.0"
|
||||
owo-colors = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
|
||||
[dev-dependencies]
|
||||
|
||||
@ -1,12 +1,15 @@
|
||||
color-spantrace
|
||||
===============
|
||||
# color-spantrace
|
||||
|
||||
[![Build Status][actions-badge]][actions-url]
|
||||
[](https://crates.io/crates/color-spantrace)
|
||||
[](https://docs.rs/color-spantrace)
|
||||
[![Latest Version][version-badge]][version-url]
|
||||
[![Rust Documentation][docs-badge]][docs-url]
|
||||
|
||||
[actions-badge]: https://github.com/eyre-rs/color-spantrace/workflows/Continuous%20integration/badge.svg
|
||||
[actions-url]: https://github.com/eyre-rs/color-spantrace/actions?query=workflow%3A%22Continuous+integration%22
|
||||
[actions-badge]: https://github.com/eyre-rs/eyre/workflows/Continuous%20integration/badge.svg
|
||||
[actions-url]: https://github.com/eyre-rs/eyre/actions?query=workflow%3A%22Continuous+integration%22
|
||||
[version-badge]: https://img.shields.io/crates/v/color-spantrace.svg
|
||||
[version-url]: https://crates.io/crates/color-spantrace
|
||||
[docs-badge]: https://img.shields.io/badge/docs-latest-blue.svg
|
||||
[docs-url]: https://docs.rs/color-spantrace
|
||||
|
||||
A rust library for colorizing [`tracing_error::SpanTrace`] objects in the style
|
||||
of [`color-backtrace`].
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user