debug-ignore-1.0.5/.cargo/config.toml000064400000000000000000000000731046102023000155110ustar 00000000000000[alias] xfmt = "fmt -- --config imports_granularity=Crate" debug-ignore-1.0.5/.cargo_vcs_info.json0000644000000001360000000000100134060ustar { "git": { "sha1": "47a911cefdba591b75fba4a3c8e208558d11ebfd" }, "path_in_vcs": "" }debug-ignore-1.0.5/.github/FUNDING.yml000064400000000000000000000000231046102023000153460ustar 00000000000000github: sunshowers debug-ignore-1.0.5/.github/workflows/ci.yml000064400000000000000000000027051046102023000167150ustar 00000000000000on: push: branches: - main pull_request: branches: - main name: CI jobs: lint: name: Lint runs-on: ubuntu-latest env: RUSTFLAGS: -D warnings steps: - uses: actions/checkout@v3 - uses: dtolnay/rust-toolchain@stable with: components: rustfmt, clippy - uses: Swatinem/rust-cache@v2 - name: Lint (clippy) run: cargo clippy --all-features --all-targets - name: Lint (rustfmt) run: cargo xfmt --check - name: Install cargo readme uses: baptiste0928/cargo-install@v1 with: crate: cargo-readme - name: Run cargo readme run: ./scripts/regenerate-readmes.sh - name: Check for differences run: git diff --exit-code build: name: Build and test runs-on: ${{ matrix.os }} strategy: matrix: os: [ ubuntu-latest ] # 1.34 is the MSRV rust-version: [ 1.34, stable ] fail-fast: false env: RUSTFLAGS: -D warnings steps: - uses: actions/checkout@v3 - uses: dtolnay/rust-toolchain@master with: toolchain: ${{ matrix.rust-version }} - uses: Swatinem/rust-cache@v2 - name: Use pinned Cargo.lock for Rust 1.34 if: ${{ matrix.rust-version == 1.34 }} run: cp Cargo.lock.rust134 Cargo.lock - name: Build run: cargo build --all-features - name: Test run: cargo test --all-features debug-ignore-1.0.5/.github/workflows/docs.yml000064400000000000000000000013141046102023000172450ustar 00000000000000on: push: branches: - main name: Docs jobs: docs: name: Build and deploy documentation concurrency: ci-${{ github.ref }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: dtolnay/rust-toolchain@stable - uses: Swatinem/rust-cache@v2 - name: Build rustdoc run: cargo doc --all-features --workspace - name: Organize run: | rm -rf target/gh-pages mkdir target/gh-pages mv target/doc target/gh-pages/rustdoc - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v4 with: branch: gh-pages folder: target/gh-pages single-commit: true debug-ignore-1.0.5/.github/workflows/release.yml000064400000000000000000000013751046102023000177440ustar 00000000000000# adapted from https://github.com/taiki-e/cargo-hack/blob/main/.github/workflows/release.yml name: Publish releases to GitHub on: push: tags: - '*' jobs: create-release: if: github.repository_owner == 'sunshowers-code' runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v3 with: persist-credentials: false - name: Install Rust uses: dtolnay/rust-toolchain@stable - run: cargo publish env: CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} - uses: taiki-e/create-gh-release-action@v1 with: changelog: CHANGELOG.md title: debug-ignore $version branch: main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} debug-ignore-1.0.5/.gitignore000064400000000000000000000000231046102023000141610ustar 00000000000000/target Cargo.lock debug-ignore-1.0.5/CHANGELOG.md000064400000000000000000000021451046102023000140110ustar 00000000000000# Changelog ## [1.0.5] - 2023-01-07 ### Fixed - Fixed link to documentation off of main in readme. ## [1.0.4] - 2023-01-07 ### Added - Add a `From` impl for `DebugIgnore` ([#3]). [#3]: https://github.com/sunshowers-code/debug-ignore/issues/3 ## [1.0.3] - 2022-08-30 ### Added - This crate is now compatible with no-std ([#2]). Thanks [Finomnis] for your first contribution! [#2]: https://github.com/sunshowers-code/debug-ignore/pull/2 [Finomnis]: https://github.com/Finomnis ## [1.0.2] - 2022-03-17 ### Added - Automatically derive `Default` for `DebugIgnore` ([#1]). Thanks [@euclio]! [#1]: https://github.com/sunshowers-code/debug-ignore/pull/1 [@euclio]: https://github.com/euclio ## [1.0.1] - 2021-10-01 - Initial version. [1.0.5]: https://github.com/sunshowers-code/debug-ignore/releases/tag/1.0.5 [1.0.4]: https://github.com/sunshowers-code/debug-ignore/releases/tag/1.0.4 [1.0.3]: https://github.com/sunshowers-code/debug-ignore/releases/tag/1.0.3 [1.0.2]: https://github.com/sunshowers-code/debug-ignore/releases/tag/1.0.2 [1.0.1]: https://github.com/sunshowers-code/debug-ignore/releases/tag/1.0.1 debug-ignore-1.0.5/CODE_OF_CONDUCT.md000064400000000000000000000126121046102023000147770ustar 00000000000000# Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [rain@sunshowers.io](mailto:rain@sunshowers.io). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations debug-ignore-1.0.5/Cargo.lock.rust134000064400000000000000000000072231046102023000153330ustar 00000000000000# This file is automatically @generated by Cargo. # It is not intended for manual editing. [[package]] name = "debug-ignore" version = "1.0.1" dependencies = [ "serde 1.0.136 (registry+https://github.com/rust-lang/crates.io-index)", "serde_json 1.0.68 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "itoa" version = "0.4.8" source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] name = "proc-macro2" version = "1.0.36" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "unicode-xid 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "quote" version = "1.0.15" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "proc-macro2 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "ryu" version = "1.0.6" source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] name = "serde" version = "1.0.136" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "serde_derive 1.0.136 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "serde_derive" version = "1.0.136" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "proc-macro2 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)", "quote 1.0.15 (registry+https://github.com/rust-lang/crates.io-index)", "syn 1.0.87 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "serde_json" version = "1.0.68" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "itoa 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)", "ryu 1.0.6 (registry+https://github.com/rust-lang/crates.io-index)", "serde 1.0.136 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "syn" version = "1.0.87" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "proc-macro2 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)", "quote 1.0.15 (registry+https://github.com/rust-lang/crates.io-index)", "unicode-xid 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "unicode-xid" version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" [metadata] "checksum itoa 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)" = "b71991ff56294aa922b450139ee08b3bfc70982c6b2c7562771375cf73542dd4" "checksum proc-macro2 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)" = "c7342d5883fbccae1cc37a2353b09c87c9b0f3afd73f5fb9bba687a1f733b029" "checksum quote 1.0.15 (registry+https://github.com/rust-lang/crates.io-index)" = "864d3e96a899863136fc6e99f3d7cae289dafe43bf2c5ac19b70df7210c0a145" "checksum ryu 1.0.6 (registry+https://github.com/rust-lang/crates.io-index)" = "3c9613b5a66ab9ba26415184cfc41156594925a9cf3a2057e57f31ff145f6568" "checksum serde 1.0.136 (registry+https://github.com/rust-lang/crates.io-index)" = "ce31e24b01e1e524df96f1c2fdd054405f8d7376249a5110886fb4b658484789" "checksum serde_derive 1.0.136 (registry+https://github.com/rust-lang/crates.io-index)" = "08597e7152fcd306f41838ed3e37be9eaeed2b61c42e2117266a554fab4662f9" "checksum serde_json 1.0.68 (registry+https://github.com/rust-lang/crates.io-index)" = "0f690853975602e1bfe1ccbf50504d67174e3bcf340f23b5ea9992e0587a52d8" "checksum syn 1.0.87 (registry+https://github.com/rust-lang/crates.io-index)" = "1e59d925cf59d8151f25a3bedf97c9c157597c9df7324d32d68991cc399ed08b" "checksum unicode-xid 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "8ccb82d61f80a663efe1f787a51b16b5a51e3314d6ac365b08639f52387b33f3" debug-ignore-1.0.5/Cargo.toml0000644000000017500000000000100114070ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] name = "debug-ignore" version = "1.0.5" description = "A newtype wrapper that causes a field to be skipped while printing out Debug output." documentation = "https://docs.rs/debug-ignore" readme = "README.md" keywords = ["no-std"] license = "MIT OR Apache-2.0" repository = "https://github.com/sunshowers-code/debug-ignore" [[test]] name = "serde" required-features = ["serde"] [dependencies.serde] version = "1" features = ["derive"] optional = true default-features = false [dev-dependencies.serde_json] version = "1" debug-ignore-1.0.5/Cargo.toml.orig000064400000000000000000000010101046102023000150550ustar 00000000000000[package] name = "debug-ignore" description = "A newtype wrapper that causes a field to be skipped while printing out Debug output." version = "1.0.5" license = "MIT OR Apache-2.0" repository = "https://github.com/sunshowers-code/debug-ignore" documentation = "https://docs.rs/debug-ignore" keywords = ["no-std"] [dependencies] serde = { version = "1", optional = true, default-features = false, features = [ "derive", ] } [dev-dependencies] serde_json = "1" [[test]] name = "serde" required-features = ["serde"] debug-ignore-1.0.5/LICENSE-APACHE000064400000000000000000000251371046102023000141320ustar 00000000000000 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. debug-ignore-1.0.5/LICENSE-MIT000064400000000000000000000017771046102023000136460ustar 00000000000000Permission 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. debug-ignore-1.0.5/README.md000064400000000000000000000051211046102023000134540ustar 00000000000000# debug-ignore [![debug-ignore on crates.io](https://img.shields.io/crates/v/debug-ignore)](https://crates.io/crates/debug-ignore) [![Documentation (latest release)](https://docs.rs/debug-ignore/badge.svg)](https://docs.rs/debug-ignore/) [![Documentation (main)](https://img.shields.io/badge/docs-main-brightgreen)](https://sunshowers-code.github.io/debug-ignore/rustdoc/debug_ignore/) [![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE-APACHE) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE-MIT) This library contains `DebugIgnore`, a newtype wrapper that causes a field to be skipped while printing out `Debug` output. ## Examples ```rust use debug_ignore::DebugIgnore; // Some structs have many fields with large `Debug` implementations. #[derive(Debug)] struct InnerStructWithLotsOfDebugInfo { field: &'static str, // ... } #[derive(Debug)] pub struct PublicStruct { inner: DebugIgnore, } impl PublicStruct { pub fn new() -> Self { Self { // DebugIgnore has a `From` impl for the inner type; you can also construct // one explicitly. inner: InnerStructWithLotsOfDebugInfo { field: "field", /* ... */ }.into(), } } } let x = PublicStruct::new(); assert_eq!(format!("{:?}", x), "PublicStruct { inner: ... }"); // Fields within inner can still be accessed through the Deref impl. assert_eq!(x.inner.field, "field"); ``` ## Why? Some structs have many fields with large `Debug` implementations. It can be really annoying to go through a ton of usually irrelevant `Debug` output. `DebugIgnore` is a zero-cost, zero-compile-time way to achieve a `Debug` impl that skips over a field. ## Optional features `serde`: `serde` support with `#[serde(transparent)]`. ## Rust version support The MSRV is **Rust 1.34** though this crate likely builds with older versions. This crate is too trivial to require anything more recent. Optional features may require newer versions of Rust. ## Alternatives * Implement `Debug` by hand. * [`derivative`](https://crates.io/crates/derivative) has greater control over the behavior of `Debug` impls, at the cost of a compile-time proc-macro dependency. ## Contributing Pull requests are welcome! Please follow the [code of conduct](CODE_OF_CONDUCT.md). ## License This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT license](LICENSE-MIT). debug-ignore-1.0.5/README.tpl000064400000000000000000000016471046102023000136640ustar 00000000000000# {{crate}} [![debug-ignore on crates.io](https://img.shields.io/crates/v/debug-ignore)](https://crates.io/crates/debug-ignore) [![Documentation (latest release)](https://docs.rs/debug-ignore/badge.svg)](https://docs.rs/debug-ignore/) [![Documentation (main)](https://img.shields.io/badge/docs-main-brightgreen)](https://sunshowers-code.github.io/debug-ignore/rustdoc/debug_ignore/) [![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE-APACHE) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE-MIT) {{readme}} ## Contributing Pull requests are welcome! Please follow the [code of conduct](CODE_OF_CONDUCT.md). ## License This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT license](LICENSE-MIT). debug-ignore-1.0.5/release.toml000064400000000000000000000004231046102023000145120ustar 00000000000000sign-tag = true # Required for templates below to work consolidate-commits = false pre-release-commit-message = "[{{crate_name}}] version {{version}}" tag-message = "[{{crate_name}}] version {{version}}" tag-name = "{{version}}" publish = false dependent-version = "upgrade" debug-ignore-1.0.5/scripts/regenerate-readmes.sh000075500000000000000000000005521046102023000177650ustar 00000000000000#!/usr/bin/env bash # Copyright (c) The cargo-guppy Contributors # SPDX-License-Identifier: MIT OR Apache-2.0 # Regenerate readme files in this repository. set -eo pipefail cd "$(git rev-parse --show-toplevel)" git ls-files | grep README.tpl$ | while read -r readme; do dir=$(dirname "$readme") cargo readme --project-root "$dir" > "$dir/README.md" done debug-ignore-1.0.5/src/lib.rs000064400000000000000000000071011046102023000141000ustar 00000000000000// Copyright (c) The debug-ignore Contributors // SPDX-License-Identifier: MIT OR Apache-2.0 //! This library contains `DebugIgnore`, a newtype wrapper that causes a field to be skipped while //! printing out `Debug` output. //! //! # Examples //! //! ```rust //! use debug_ignore::DebugIgnore; //! //! // Some structs have many fields with large `Debug` implementations. //! #[derive(Debug)] //! struct InnerStructWithLotsOfDebugInfo { //! field: &'static str, //! // ... //! } //! //! #[derive(Debug)] //! pub struct PublicStruct { //! inner: DebugIgnore, //! } //! //! impl PublicStruct { //! pub fn new() -> Self { //! Self { //! // DebugIgnore has a `From` impl for the inner type; you can also construct //! // one explicitly. //! inner: InnerStructWithLotsOfDebugInfo { field: "field", /* ... */ }.into(), //! } //! } //! } //! //! let x = PublicStruct::new(); //! assert_eq!(format!("{:?}", x), "PublicStruct { inner: ... }"); //! //! // Fields within inner can still be accessed through the Deref impl. //! assert_eq!(x.inner.field, "field"); //! ``` //! //! # Why? //! //! Some structs have many fields with large `Debug` implementations. It can be really annoying to //! go through a ton of usually irrelevant `Debug` output. //! //! `DebugIgnore` is a zero-cost, zero-compile-time way to achieve a `Debug` impl that skips over a //! field. //! //! # Optional features //! //! `serde`: `serde` support with `#[serde(transparent)]`. //! //! # Rust version support //! //! The MSRV is **Rust 1.34** though this crate likely builds with older versions. This crate is //! too trivial to require anything more recent. //! //! Optional features may require newer versions of Rust. //! //! # Alternatives //! //! * Implement `Debug` by hand. //! * [`derivative`](https://crates.io/crates/derivative) has greater control over the behavior of //! `Debug` impls, at the cost of a compile-time proc-macro dependency. #![no_std] use core::{ fmt, ops::{Deref, DerefMut}, str::FromStr, }; /// A newtype wrapper that causes the field within to be ignored while printing out `Debug` output. /// /// For more, see the [crate documentation](self). #[derive(Copy, Clone, Default, Eq, Hash, Ord, PartialEq, PartialOrd)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] #[repr(transparent)] #[cfg_attr(feature = "serde", serde(transparent))] pub struct DebugIgnore(pub T); /// The point of this struct. impl fmt::Debug for DebugIgnore { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "...") } } // --- // Other trait impls // --- impl From for DebugIgnore { #[inline] fn from(t: T) -> Self { Self(t) } } impl Deref for DebugIgnore { type Target = T; #[inline] fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for DebugIgnore { #[inline] fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl FromStr for DebugIgnore { type Err = T::Err; #[inline] fn from_str(s: &str) -> Result { s.parse().map(DebugIgnore) } } impl fmt::Display for DebugIgnore { #[inline] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) } } impl AsRef for DebugIgnore where T: AsRef, { #[inline] fn as_ref(&self) -> &Q { self.0.as_ref() } } debug-ignore-1.0.5/tests/serde.rs000064400000000000000000000006321046102023000150110ustar 00000000000000// Copyright (c) The debug-ignore Contributors // SPDX-License-Identifier: MIT OR Apache-2.0 extern crate debug_ignore; use debug_ignore::DebugIgnore; #[test] fn test_transparent() { assert_eq!( serde_json::from_str::>(r#""foo""#).unwrap(), DebugIgnore("foo") ); assert_eq!( serde_json::to_string(&DebugIgnore("bar")).unwrap(), r#""bar""#, ) }