├── .github ├── dependabot.yml └── workflows │ └── ci.yml ├── .gitignore ├── CHANGELOG.md ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples └── context.rs ├── src └── lib.rs └── tests ├── arg.rs ├── arg_pattern.rs ├── as_ref.rs ├── async_as_ref.rs ├── async_borrowing.rs ├── async_move.rs ├── async_no_move.rs ├── async_without_return.rs ├── async_without_return.stderr ├── failure.rs ├── fmt_args.rs ├── fmt_missing_arg.rs ├── fmt_missing_arg.stderr ├── fmt_named_arg.rs ├── fmt_unused_arg.rs ├── fmt_unused_arg.stderr ├── inherent.rs ├── missing_fmt.rs ├── missing_fmt.stderr ├── move.rs ├── no_move.rs ├── non_copy_arg.rs ├── non_copy_fmt_arg.rs ├── preserve_lint.rs ├── preserve_lint.stderr ├── simple.rs ├── tests.rs └── version_numbers.rs /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: cargo 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | open-pull-requests-limit: 10 8 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | branches: 8 | - master 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | rust_version: [stable] 15 | steps: 16 | - uses: actions/checkout@v1 17 | - name: Setup Rust toolchain 18 | run: rustup default ${{ matrix.rust_version }} 19 | - name: Build 20 | run: cargo build --all --verbose 21 | - name: Run tests 22 | run: cargo test --all --verbose 23 | - name: Rustfmt and Clippy 24 | run: | 25 | cargo fmt -- --check 26 | cargo clippy 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## 0.2.1 4 | 5 | * Update syn to 2.0.4 6 | 7 | ## 0.2.0 8 | 9 | * Fix some borrow checker errors with synchronous functions, and add the `#[context(move, "context")]` syntax to support functions which consume their arguments. Thanks to [@KaiJewson](https://github.com/KaiJewson) for [#5](https://github.com/andrewhickman/fn-error-context/pull/5). 10 | 11 | ## 0.1.2 12 | 13 | * Fixed lints like `dead_code` not triggering for functions annotated with `#[context]` ([#3](https://github.com/andrewhickman/fn-error-context/issues/3)). 14 | 15 | ## 0.1.1 16 | 17 | * Added async function support - thanks to [@tailhook](https://github.com/tailhook) for [#2](https://github.com/andrewhickman/fn-error-context/pull/2). 18 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "fn-error-context" 3 | description = "An attribute macro to add context to errors from a function." 4 | version = "0.2.1" 5 | authors = ["Andrew Hickman "] 6 | repository = "https://github.com/andrewhickman/fn-error-context" 7 | documentation = "https://docs.rs/fn-error-context" 8 | license = "MIT/Apache-2.0" 9 | readme = "README.md" 10 | edition = "2018" 11 | autotests = false 12 | 13 | [lib] 14 | name = "fn_error_context" 15 | proc-macro = true 16 | 17 | [[test]] 18 | name = "tests" 19 | path = "tests/tests.rs" 20 | 21 | [[test]] 22 | name = "version-numbers" 23 | path = "tests/version_numbers.rs" 24 | 25 | [dependencies] 26 | quote = "1.0.3" 27 | proc-macro2 = "1.0.9" 28 | syn = { version = "2.0.4", features = ["full"] } 29 | 30 | [dev-dependencies] 31 | anyhow = "1.0.27" 32 | trybuild = "1.0.24" 33 | failure = "0.1.7" 34 | version-sync = "0.9.1" 35 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Crates.io][ci]][cl] [![Docs.rs][di]][dl] 2 | 3 | [ci]: https://img.shields.io/crates/v/fn-error-context.svg 4 | [cl]: https://crates.io/crates/fn-error-context/ 5 | 6 | [di]: https://docs.rs/fn-error-context/badge.svg 7 | [dl]: https://docs.rs/fn-error-context/ 8 | 9 | # fn-error-context 10 | 11 | An attribute macro to add context to errors from a function. 12 | 13 | ``` 14 | #[context("failed to parse config at `{}`", path.display())] 15 | pub fn parse_config(path: &Path) -> anyhow::Result { 16 | let text = read_to_string(path)?; 17 | Ok(text.parse()?) 18 | } 19 | ``` -------------------------------------------------------------------------------- /examples/context.rs: -------------------------------------------------------------------------------- 1 | use std::fs::read_to_string; 2 | use std::path::Path; 3 | 4 | use fn_error_context::context; 5 | 6 | #[context("failed to parse config at `{}`", path.as_ref().display())] 7 | pub fn parse_config(path: impl AsRef) -> anyhow::Result { 8 | let text = read_to_string(path.as_ref())?; 9 | Ok(text.parse()?) 10 | } 11 | 12 | fn main() -> anyhow::Result<()> { 13 | println!("config: {}", parse_config("config")?); 14 | Ok(()) 15 | } 16 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! This crate provides the [`context`](attr.context.html) macro for adding extra error 2 | //! information to a function. 3 | //! 4 | //! Works with [`anyhow`], [`failure`] and any other error type which 5 | //! provides a `context` method taking a string. 6 | //! 7 | //! ``` 8 | //! # use std::fs::read_to_string; 9 | //! # use std::path::Path; 10 | //! # use std::io; 11 | //! # 12 | //! use fn_error_context::context; 13 | //! 14 | //! #[context("failed to parse config at `{}`", path.as_ref().display())] 15 | //! pub fn parse_config(path: impl AsRef) -> anyhow::Result { 16 | //! let text = read_to_string(path.as_ref())?; 17 | //! Ok(text.parse()?) 18 | //! } 19 | //! 20 | //! let error = parse_config("not-found").unwrap_err(); 21 | //! assert_eq!( 22 | //! error.to_string(), 23 | //! "failed to parse config at `not-found`", 24 | //! ); 25 | //! assert_eq!( 26 | //! error.source().unwrap().downcast_ref::().unwrap().kind(), 27 | //! io::ErrorKind::NotFound, 28 | //! ); 29 | //! ``` 30 | //! 31 | //! [`anyhow`]: https://crates.io/crates/anyhow 32 | //! [`failure`]: https://crates.io/crates/failure 33 | 34 | #![doc(html_root_url = "https://docs.rs/fn-error-context/0.2.1")] 35 | #![deny(missing_docs)] 36 | 37 | extern crate proc_macro; 38 | 39 | use proc_macro::TokenStream; 40 | use proc_macro2::{Ident, Span, TokenStream as TokenStream2}; 41 | use quote::{quote, ToTokens}; 42 | use syn::parse::{self, Parse, ParseStream}; 43 | use syn::Token; 44 | 45 | /// Add context to errors from a function. 46 | /// 47 | /// The arguments to this macro are a format string with arguments using 48 | /// the standard `std::fmt` syntax. Arguments to the function can be used 49 | /// as long as they are not consumed in the function body. 50 | /// 51 | /// This macro desugars to something like 52 | /// ``` 53 | /// # fn function_body() -> anyhow::Result<()> { unimplemented!() } 54 | /// # 55 | /// pub fn function() -> anyhow::Result<()> { 56 | /// (|| -> anyhow::Result<()> { 57 | /// function_body() 58 | /// })().map_err(|err| err.context("context")) 59 | /// } 60 | /// ``` 61 | /// 62 | /// Sometimes you will receive borrowck errors, especially when returning references. These can 63 | /// often be fixed by setting the `move` option of the attribute macro. For example: 64 | /// 65 | /// ``` 66 | /// use fn_error_context::context; 67 | /// 68 | /// #[context(move, "context")] 69 | /// fn returns_reference(val: &mut u32) -> anyhow::Result<&mut u32> { 70 | /// Ok(&mut *val) 71 | /// } 72 | /// ``` 73 | #[proc_macro_attribute] 74 | pub fn context(args: TokenStream, input: TokenStream) -> TokenStream { 75 | let Args(move_token, format_args) = syn::parse_macro_input!(args); 76 | let mut input = syn::parse_macro_input!(input as syn::ItemFn); 77 | 78 | let body = &input.block; 79 | let return_ty = &input.sig.output; 80 | let err = Ident::new("err", Span::mixed_site()); 81 | let new_body = if input.sig.asyncness.is_some() { 82 | let return_ty = match return_ty { 83 | syn::ReturnType::Default => { 84 | return syn::Error::new_spanned(input, "function should return Result") 85 | .to_compile_error() 86 | .into(); 87 | } 88 | syn::ReturnType::Type(_, return_ty) => return_ty, 89 | }; 90 | let result = Ident::new("result", Span::mixed_site()); 91 | quote! { 92 | let #result: #return_ty = async #move_token { #body }.await; 93 | #result.map_err(|#err| #err.context(format!(#format_args)).into()) 94 | } 95 | } else { 96 | let force_fn_once = Ident::new("force_fn_once", Span::mixed_site()); 97 | quote! { 98 | // Moving a non-`Copy` value into the closure tells borrowck to always treat the closure 99 | // as a `FnOnce`, preventing some borrowing errors. 100 | let #force_fn_once = ::core::iter::empty::<()>(); 101 | (#move_token || #return_ty { 102 | ::core::mem::drop(#force_fn_once); 103 | #body 104 | })().map_err(|#err| #err.context(format!(#format_args)).into()) 105 | } 106 | }; 107 | input.block.stmts = vec![syn::Stmt::Expr(syn::Expr::Verbatim(new_body), None)]; 108 | 109 | input.into_token_stream().into() 110 | } 111 | 112 | struct Args(Option, TokenStream2); 113 | impl Parse for Args { 114 | fn parse(input: ParseStream<'_>) -> parse::Result { 115 | let move_token = if input.peek(Token![move]) { 116 | let token = input.parse()?; 117 | input.parse::()?; 118 | Some(token) 119 | } else { 120 | None 121 | }; 122 | Ok(Self(move_token, input.parse()?)) 123 | } 124 | } 125 | -------------------------------------------------------------------------------- /tests/arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | fn do_stuff(arg: u32) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff(1).unwrap_err()), 11 | "context: error 1" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/arg_pattern.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | fn do_stuff((x, y): (i32, u32)) -> anyhow::Result<()> { 5 | anyhow::bail!("error {} {}", x, y) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff((1, 2)).unwrap_err()), 11 | "context: error 1 2" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/as_ref.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context {}", arg.as_ref())] 4 | fn do_stuff(arg: impl AsRef) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg.as_ref()) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff("hello").unwrap_err()), 11 | "context hello: error hello" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/async_as_ref.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context {}", arg.as_ref())] 4 | async fn do_stuff(arg: impl AsRef) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg.as_ref()) 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/async_borrowing.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | async fn borrows(x: &mut u32) -> anyhow::Result<&mut u32> { 5 | Ok(x) 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/async_move.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context(move, "context")] 4 | async fn borrows(val: &mut u32) -> anyhow::Result<&u32> { 5 | Ok(&*val) 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/async_no_move.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("{}", context.as_ref())] 4 | async fn no_move(context: impl AsRef) -> anyhow::Result<()> { 5 | context.as_ref(); 6 | Ok(()) 7 | } 8 | 9 | fn main() {} 10 | -------------------------------------------------------------------------------- /tests/async_without_return.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | async fn async_something() { 5 | } 6 | 7 | fn main() { 8 | } 9 | -------------------------------------------------------------------------------- /tests/async_without_return.stderr: -------------------------------------------------------------------------------- 1 | error: function should return Result 2 | --> $DIR/async_without_return.rs:4:1 3 | | 4 | 4 | / async fn async_something() { 5 | 5 | | } 6 | | |_^ 7 | -------------------------------------------------------------------------------- /tests/failure.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | fn do_stuff() -> failure::Fallible<()> { 5 | failure::bail!("error") 6 | } 7 | 8 | fn main() { 9 | let err = do_stuff().unwrap_err(); 10 | assert_eq!(format!("{}", err), "context"); 11 | assert_eq!(format!("{}", err.as_fail().cause().unwrap()), "error"); 12 | } 13 | -------------------------------------------------------------------------------- /tests/fmt_args.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context {}", arg)] 4 | fn do_stuff(arg: u32) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff(1).unwrap_err()), 11 | "context 1: error 1" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/fmt_missing_arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("{}")] 4 | fn do_stuff() -> anyhow::Result<()> { 5 | anyhow::bail!("error") 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/fmt_missing_arg.stderr: -------------------------------------------------------------------------------- 1 | error: 1 positional argument in format string, but no arguments were given 2 | --> $DIR/fmt_missing_arg.rs:3:12 3 | | 4 | 3 | #[context("{}")] 5 | | ^^ 6 | -------------------------------------------------------------------------------- /tests/fmt_named_arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context {arg}", arg = arg)] 4 | fn do_stuff(arg: u32) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff(1).unwrap_err()), 11 | "context 1: error 1" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/fmt_unused_arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context", 1)] 4 | fn do_stuff() -> anyhow::Result<()> { 5 | anyhow::bail!("error") 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/fmt_unused_arg.stderr: -------------------------------------------------------------------------------- 1 | error: argument never used 2 | --> $DIR/fmt_unused_arg.rs:3:22 3 | | 4 | 3 | #[context("context", 1)] 5 | | --------- ^ argument never used 6 | | | 7 | | formatting specifier missing 8 | -------------------------------------------------------------------------------- /tests/inherent.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | struct Foo(u32); 4 | 5 | impl Foo { 6 | #[context("context")] 7 | fn do_stuff(&self) -> anyhow::Result<()> { 8 | anyhow::bail!("error {}", self.0) 9 | } 10 | 11 | #[context("context")] 12 | async fn do_async_stuff(&self) -> anyhow::Result<()> { 13 | anyhow::bail!("error {}", self.0) 14 | } 15 | } 16 | 17 | fn main() { 18 | assert_eq!( 19 | format!("{:#}", Foo(1).do_stuff().unwrap_err()), 20 | "context: error 1" 21 | ); 22 | } 23 | -------------------------------------------------------------------------------- /tests/missing_fmt.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context] 4 | fn do_stuff() -> anyhow::Result<()> { 5 | anyhow::bail!("error") 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/missing_fmt.stderr: -------------------------------------------------------------------------------- 1 | error: requires at least a format string argument 2 | --> tests/missing_fmt.rs:3:1 3 | | 4 | 3 | #[context] 5 | | ^^^^^^^^^^ 6 | | 7 | = note: this error originates in the macro `$crate::__export::format_args` which comes from the expansion of the attribute macro `context` (in Nightly builds, run with -Z macro-backtrace for more info) 8 | -------------------------------------------------------------------------------- /tests/move.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context(move, "context")] 4 | fn foo(x: &mut u32) -> anyhow::Result<&u32> { 5 | Ok(&*x) 6 | } 7 | 8 | fn main() {} 9 | -------------------------------------------------------------------------------- /tests/no_move.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("{}", context.as_ref())] 4 | fn no_move(context: impl AsRef) -> anyhow::Result<()> { 5 | context.as_ref(); 6 | Ok(()) 7 | } 8 | 9 | fn main() {} 10 | -------------------------------------------------------------------------------- /tests/non_copy_arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | fn do_stuff(arg: String) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff("hello".to_owned()).unwrap_err()), 11 | "context: error hello" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/non_copy_fmt_arg.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context {}", arg)] 4 | fn do_stuff(arg: String) -> anyhow::Result<()> { 5 | anyhow::bail!("error {}", arg) 6 | } 7 | 8 | fn main() { 9 | assert_eq!( 10 | format!("{:#}", do_stuff("hello".to_owned()).unwrap_err()), 11 | "context hello: error hello" 12 | ); 13 | } 14 | -------------------------------------------------------------------------------- /tests/preserve_lint.rs: -------------------------------------------------------------------------------- 1 | // See https://github.com/andrewhickman/fn-error-context/issues/3 2 | #![deny(dead_code)] 3 | 4 | use fn_error_context::context; 5 | 6 | #[context("context")] 7 | fn do_stuff() -> anyhow::Result<()> { 8 | anyhow::bail!("error") 9 | } 10 | 11 | fn main() {} 12 | -------------------------------------------------------------------------------- /tests/preserve_lint.stderr: -------------------------------------------------------------------------------- 1 | error: function `do_stuff` is never used 2 | --> tests/preserve_lint.rs:7:4 3 | | 4 | 7 | fn do_stuff() -> anyhow::Result<()> { 5 | | ^^^^^^^^ 6 | | 7 | note: the lint level is defined here 8 | --> tests/preserve_lint.rs:2:9 9 | | 10 | 2 | #![deny(dead_code)] 11 | | ^^^^^^^^^ 12 | -------------------------------------------------------------------------------- /tests/simple.rs: -------------------------------------------------------------------------------- 1 | use fn_error_context::context; 2 | 3 | #[context("context")] 4 | fn do_stuff() -> anyhow::Result<()> { 5 | anyhow::bail!("error") 6 | } 7 | 8 | fn main() { 9 | assert_eq!(format!("{:#}", do_stuff().unwrap_err()), "context: error"); 10 | } 11 | -------------------------------------------------------------------------------- /tests/tests.rs: -------------------------------------------------------------------------------- 1 | #[test] 2 | fn tests() { 3 | let tests = trybuild::TestCases::new(); 4 | 5 | tests.pass("tests/simple.rs"); 6 | tests.pass("tests/arg.rs"); 7 | tests.pass("tests/arg_pattern.rs"); 8 | tests.pass("tests/inherent.rs"); 9 | tests.compile_fail("tests/missing_fmt.rs"); 10 | tests.pass("tests/fmt_args.rs"); 11 | tests.pass("tests/failure.rs"); 12 | tests.pass("tests/non_copy_arg.rs"); 13 | tests.pass("tests/non_copy_fmt_arg.rs"); 14 | tests.pass("tests/as_ref.rs"); 15 | tests.pass("tests/async_as_ref.rs"); 16 | tests.compile_fail("tests/fmt_missing_arg.rs"); 17 | tests.compile_fail("tests/fmt_unused_arg.rs"); 18 | tests.pass("tests/fmt_named_arg.rs"); 19 | tests.compile_fail("tests/async_without_return.rs"); 20 | tests.compile_fail("tests/preserve_lint.rs"); 21 | tests.pass("tests/async_borrowing.rs"); 22 | tests.pass("tests/no_move.rs"); 23 | tests.pass("tests/async_no_move.rs"); 24 | tests.pass("tests/move.rs"); 25 | tests.pass("tests/async_move.rs"); 26 | } 27 | -------------------------------------------------------------------------------- /tests/version_numbers.rs: -------------------------------------------------------------------------------- 1 | #[test] 2 | fn test_readme_deps() { 3 | version_sync::assert_markdown_deps_updated!("README.md"); 4 | } 5 | 6 | #[test] 7 | fn test_html_root_url() { 8 | version_sync::assert_html_root_url_updated!("src/lib.rs"); 9 | } 10 | --------------------------------------------------------------------------------