From 38104c19c1f74d0a63d4236efd21371b70c16fc8 Mon Sep 17 00:00:00 2001 From: mcmah309 Date: Mon, 23 Dec 2024 22:18:18 +0000 Subject: [PATCH] feat: Merge err_trail into error_set --- err_trail/Cargo.toml | 6 +- err_trail/LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ error_set/Cargo.toml | 9 +- error_set/src/context.rs | 8 ++ error_set/src/lib.rs | 2 + 5 files changed, 221 insertions(+), 5 deletions(-) create mode 100644 err_trail/LICENSE diff --git a/err_trail/Cargo.toml b/err_trail/Cargo.toml index 3151b1f..d48ba32 100644 --- a/err_trail/Cargo.toml +++ b/err_trail/Cargo.toml @@ -1,7 +1,11 @@ [package] name = "err_trail" -version = "0.1.0" +description = "Add context to errors through logging" +version = "0.8.3" edition = "2021" +license = "Apache-2.0" +documentation = "https://docs.rs/err_trail" +repository = "https://github.com/mcmah309/error_set" [dependencies] tracing = { version = "0.1", optional = true } diff --git a/err_trail/LICENSE b/err_trail/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/err_trail/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/error_set/Cargo.toml b/error_set/Cargo.toml index a809227..2a96a39 100644 --- a/error_set/Cargo.toml +++ b/error_set/Cargo.toml @@ -12,6 +12,7 @@ rust-version = "1.81" [dependencies] error_set_impl = { version = "=0.8.3", path = "../error_set_impl" } +err_trail = {version = "=0.8.3", path = "../err_trail"} # features tracing = { version = "0.1", optional = true } @@ -27,13 +28,13 @@ lazy_static = "1" [features] default = [] # Enables support for the tracing crate. Adds methods to `Result` that are applied on `Err` - e.g. `result.warn(...)`. -tracing = ["dep:tracing"] +tracing = ["dep:tracing", "err_trail/tracing"] # Enables support for the log crate. Adds methods to `Result` that are applied on `Err` - e.g. `result.warn(...)`. -log = ["dep:log"] +log = ["dep:log", "err_trail/log"] # Enables support for the defmt crate, which works with no_std. Adds methods to `Result` that are applied on `Err` - e.g. `result.warn(...)`. -defmt = ["dep:defmt"] +defmt = ["dep:defmt", "err_trail/defmt"] # Enables support for the log/tracing/defmt api, without pulling in any crates. Allowing a downstream to choose the appropriate crate. -context_stub = [] +context_stub = ["err_trail/stub"] [package.metadata.docs.rs] all-features = false diff --git a/error_set/src/context.rs b/error_set/src/context.rs index 07e9434..3542833 100644 --- a/error_set/src/context.rs +++ b/error_set/src/context.rs @@ -8,6 +8,7 @@ mod sealed { } /// For logging a [Result] when an [Err] is encountered. +#[deprecated(note = "Use `ErrContext` instead")] #[cfg_attr(docsrs, doc(cfg(any(feature = "tracing", feature = "log", feature = "defmt", feature = "context_stub"))))] pub trait ResultContext: sealed::Sealed { /// Log the context as an "error" if the Result is an [Err]. @@ -45,6 +46,7 @@ pub trait ResultContext: sealed::Sealed { } /// For logging a [Result]'s [Err] in the [Debug] format when an [Err] is encountered. +#[deprecated(note = "Use `ErrContextDisplay` instead")] #[cfg_attr(docsrs, doc(cfg(any(feature = "tracing", feature = "log", feature = "defmt", feature = "context_stub"))))] pub trait ConsumeDebug: sealed::Sealed { /// Consumes the [Err] of a Result. if [Err], logging as an "error". @@ -60,6 +62,7 @@ pub trait ConsumeDebug: sealed::Sealed { } /// For logging a [Result]'s [Err] in the [Display] format when an [Err] is encountered. +#[deprecated(note = "Use `ErrContextDisplay` instead")] #[cfg_attr(docsrs, doc(cfg(any(feature = "tracing", feature = "log", feature = "defmt", feature = "context_stub"))))] pub trait ConsumeDisplay: sealed::Sealed { /// Consumes the [Err] of a Result. if [Err], logging as an "error". @@ -75,6 +78,7 @@ pub trait ConsumeDisplay: sealed::Sealed { } /// For logging when a [None] is encountered. +#[deprecated(note = "Use `NoneContext` instead")] #[cfg_attr(docsrs, doc(cfg(any(feature = "tracing", feature = "log", feature = "defmt", feature = "context_stub"))))] pub trait OptionContext: sealed::Sealed { /// Log the context as an "error" if the Option is [None]. @@ -101,6 +105,7 @@ pub trait OptionContext: sealed::Sealed { } impl sealed::Sealed for Result {} +#[allow(deprecated)] impl ResultContext for Result { #[inline] fn error(self, context: impl Display) -> Result { @@ -287,6 +292,7 @@ impl ResultContext for Result { } } +#[allow(deprecated)] impl ConsumeDebug for Result where E: Debug, @@ -362,6 +368,7 @@ where } } +#[allow(deprecated)] impl ConsumeDisplay for Result where E: Display, @@ -440,6 +447,7 @@ where //************************************************************************// impl sealed::Sealed for Option {} +#[allow(deprecated)] impl OptionContext for Option { #[inline] fn error(self, context: impl Display) -> Option { diff --git a/error_set/src/lib.rs b/error_set/src/lib.rs index af3369c..18d459f 100644 --- a/error_set/src/lib.rs +++ b/error_set/src/lib.rs @@ -26,6 +26,8 @@ compile_error!("Features 'log' and 'context_stub' cannot be enabled at the same compile_error!("Features 'defmt' and 'context_stub' cannot be enabled at the same time."); pub use error_set_impl::*; +#[cfg(any(feature = "tracing", feature = "log", feature = "context_stub", feature = "defmt"))] +pub use err_trail::*; pub trait CoerceResult { fn coerce>(self) -> Result;