pax_global_header00006660000000000000000000000064151073123570014516gustar00rootroot0000000000000052 comment=8b8659231d74601b4012034d566f4b88ba2ebae2 enum-map/000077500000000000000000000000001510731235700126015ustar00rootroot00000000000000enum-map/.gitignore000066400000000000000000000002251510731235700145700ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska # # SPDX-License-Identifier: CC0-1.0 or MIT OR Apache-2.0 target/ **/*.rs.bk enum-map/.reuse/000077500000000000000000000000001510731235700140025ustar00rootroot00000000000000enum-map/.reuse/dep5000066400000000000000000000003011510731235700145540ustar00rootroot00000000000000Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: enum-map Upstream-Contact: Luna Borowska Source: https://codeberg.org/xfix/enum-map enum-map/.woodpecker.yml000066400000000000000000000026051510731235700155470ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2023 - 2025 Luna Borowska # # SPDX-License-Identifier: MIT OR Apache-2.0 when: - event: pull_request - event: push branch: - master steps: lint: depends_on: [] image: fsfe/reuse:3.0.2@sha256:985ca841881779fa56560cd8478821270e78e4f23e21d7d741370a4abba3c654 commands: - reuse lint miri: depends_on: [] image: instrumentisto/rust:nightly-2025-02-26@sha256:786a8a9b058e86a7d1f57fd5af81f9b54e00d1d6b65f0588c23375aaca86fa43 environment: CARGO_TERM_COLOR: always commands: - rustup component add miri - cargo miri test --all-features --locked --verbose rustfmt: depends_on: [] image: rust:1.89.0@sha256:3329e2de3e9ff2d58da56e95ef99a3180a4e76336a676f3fe2b88f0b0d6bcfbf commands: - rustup component add rustfmt - cargo fmt --check test-stable: &rust depends_on: [] image: rust:1.89.0@sha256:3329e2de3e9ff2d58da56e95ef99a3180a4e76336a676f3fe2b88f0b0d6bcfbf environment: CARGO_TERM_COLOR: always commands: - cargo build --all-features --locked --verbose - cargo test --no-default-features --locked --verbose - cargo test --all-features --locked --verbose test-msrv: <<: *rust # Update Cargo.toml and renovate.json when updating this. image: rust:1.85.0@sha256:caa4a0e7bd1fe2e648caf3d904bc54c3bfcae9e74b4df2eb9ebe558c9e9e88c5 enum-map/CHANGELOG.md000066400000000000000000000146131510731235700144170ustar00rootroot00000000000000 # Version 3.0.0-beta.3 ## New features - Added optional support for `borsh` serialisation. ## Incompatible changes - Now requires Rust 1.66 # Version 2.7.3 ## Other changes - Fixed [a regression introduced in 2.7.2 that caused `#[derive(Enum)]` to generate incorrect code when dealing with enums containing fields](https://codeberg.org/xfix/enum-map/issues/112). # Version 2.7.2 ## Other changes - Reduced RAM usage and improved compilation times when using `derive(Enum)` for large enums with `overflow-checks` enabled. # Version 3.0.0-beta.2 ## Other changes - Updated author name. # Version 2.7.1 ## Other changes - Updated author name. # Version 3.0.0-beta.1 ## New features - Implemented `EnumMap::from_fn`. - `derive` feature is now an optional default feature. # Version 2.7.0 ## New features - Implemented `EnumMap::from_fn`. # Version 3.0.0-0.gat.0 ## Breaking changes - `Enum` and `EnumArray` traits are now combined into a single trait using generic associated types. Trait bounds talking about `EnumArray` (like `K: EnumArray`) must be replaced with `K: Enum`. # Version 2.6.3 ## Other changes - Updated the repository URL as the project was migrated from GitHub to Codeberg. - This project is now compliant with the REUSE Specification. # Version 2.6.2 ## Other changes - Hide `out_of_bounds` reexport from documentation. # Version 2.6.1 ## Other changes - Provide better panic message when providing out-of-bounds index to `Enum::from_usize``. # Version 2.6.0 ## New features - `EnumMap::as_array` is now usable in const contexts. ## Other changes - This crate now follows "N minus two" MSRV policy. This means that it supports the current Rust release, as well as the two before that. - Upgraded syn to 2.0.0. # Version 2.5.0 ## New features - Implemented `EnumMap::as_array` and `EnumMap::as_mut_array` (implemented by [@Fuuzetsu](https://github.com/Fuuzetsu)). - Implemented `PartialOrd` and `Ord` for `EnumMap` (implemented by [@nicarran](https://github.com/nicarran)). # Version 2.4.2 ## Other changes - Added license files to crate tarball. - Added changelog to crate tarball. # Version 2.4.1 ## Other changes - Improved performance of code generated for `from_usize` when deriving `Enum`. # Version 2.4.0 ## New features - Implemented `Enum` for `()` (unit type) and `core::cmp::Ordering` (implemented by [@phimuemue](https://github.com/phimuemue)). - Implemented `EnumMap::into_array`. # Version 2.3.0 ## New features - `EnumMap::len` is now usable in const contexts. ## Other changes - `Enum` derive now can deal with re-definitions of `usize` and `unimplemented`. # Version 2.2.0 ## New features - `EnumMap::from_array` is now usable in const contexts. # Version 2.1.0 ## New features - Implemented `DoubleEndedIterator` for `IntoIter`. - Implemented `EnumMap::into_values`. ## Other changes - Changed behavior of `IntoIter` so that it drops rest of the elements when one destructor panics. # Version 2.0.3 ## Other changes - Optimized performance of `enum_map!` macro. # Version 2.0.2 ## Other changes - Fixed safety problem when using `enum_map!` macro with enums that incorrectly implemented `Enum` trait. # Version 2.0.1 ## Other changes - Adjusted crate metadata to avoid lib.rs warnings. # Version 2.0.0 ## New features - Implemented `FromIterator` for `EnumMap` (implemented by @bit_network on GitLab). - Implemented `EnumMap::map`. - Derives support product types in addition to sum types (implemented by @bzim on GitLab). - It's now possible to access enum length by accessing `LENGTH` in `Enum` trait. ## Breaking changes - `Enum` trait was split into two traits, `Enum` and `EnumArray`. # Version 1.1.1 ## Other changes - Worked around a bug in Clippy that caused false positives when using `use_self` lint for code that derived `Enum` trait. # Version 1.1.0 ## New features - Implemented `Arbitrary` for maps where the value type also implements `Arbitrary`. (You have to enable the "arbitrary" feature.) # Version 1.0.0 ## New features - It's now possible to use `return` and `?` within `macro_rules!` macro. - `Enum` trait is much simpler having two methods only. ## Other changes - Removed previously deprecated features. - Renamed `to_usize` to `into_usize` matching the naming convention used in Rust programming language. # Version 0.6.5 ## Other changes - Deprecated `EnumMap::is_empty` and `EnumMap::new`. `EnumMap::new` usages can be replaced with `EnumMap::default`. # Version 0.6.4 ## Other changes - Deprecated `EnumMap::as_ptr` and `EnumMap::as_mut_ptr`. # Version 0.6.3 ## New features - `Iter` and `Values` now implements `Clone` (added by @amanieu). # Version 0.6.2. ## New features - Added `EnumMap#clear` method (added by @Riey, thanks :)). # Version 0.6.0 ## Incompatible changes - Now requires Rust 1.36. # Version 0.5.0 - Fixed the issue where an aliasing `From` trait implementation caused compilation errors with `enum_map!` macro. ## Incompatible changes - Now requires Rust 1.31. # Version 0.4.1 ## New features - Default `serde` features are disabled. This allows enabling serde feature when compiling without `std`. # Version 0.4.0 Change of `#[derive(EnumMap)]` to `#[derive(Enum)]` was supposed to appear in 0.3.0, but it was forgotten about. This release fixes just that. ## Incompatible changes - Changed `#[derive(EnumMap)]` to `#[derive(Enum)]` to match trait name. # Version 0.3.1 - Updated README use `#[derive(EnumMap)]` instead of `#[derive(Enum)]`. # Version 0.3.0 ## New features - Implemented compact serde serialization for binary formats like bincode. - Iterator traits with exception now implement `FusedIterator`. ## Incompatible changes - Increased required Rust version to 1.26.0. - Renamed `Internal` trait to `Enum`. - Added new associated constant `POSSIBLE_VALUES` to `Enum` trait, representing the number of possible values the type can have. Manual implementations are required to provide it. - Removed `Enum` implementation for `Option`. - Implemented compact serialization, for formats like `bincode`. This makes it impossible to deserialize non-compact representation used by enum-map 0.2.0. - `values` method returns `Values` as opposed to `slice::Iter`. enum-map/Cargo.lock000066400000000000000000000106331510731235700145110ustar00rootroot00000000000000# This file is automatically @generated by Cargo. # It is not intended for manual editing. version = 3 [[package]] name = "arbitrary" version = "1.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c3d036a3c4ab069c7b410a2ce876bd74808d2d0888a82667669f8e783a898bf1" [[package]] name = "bincode" version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "36eaf5d7b090263e8150820482d5d93cd964a81e4019913c972f4edcc6edb740" dependencies = [ "bincode_derive", "serde", "unty", ] [[package]] name = "bincode_derive" version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "bf95709a440f45e986983918d0e8a1f30a9b1df04918fc828670606804ac3c09" dependencies = [ "virtue", ] [[package]] name = "borsh" version = "1.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ad8646f98db542e39fc66e68a20b2144f6a732636df7c2354e74645faaa433ce" dependencies = [ "cfg_aliases", ] [[package]] name = "bytemuck" version = "1.23.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3995eaeebcdf32f91f980d360f78732ddc061097ab4e39991ae7a6ace9194677" [[package]] name = "cfg_aliases" version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724" [[package]] name = "enum-map" version = "3.0.0-beta.2" dependencies = [ "arbitrary", "bincode", "borsh", "bytemuck", "enum-map-derive", "serde", "serde_json", "serde_test", ] [[package]] name = "enum-map-derive" version = "1.0.0-beta.1" dependencies = [ "enum-map", "proc-macro2", "quote", "syn", ] [[package]] name = "itoa" version = "1.0.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38" [[package]] name = "memchr" version = "2.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a282da65faaf38286cf3be983213fcf1d2e2a58700e808f83f4ea9a4804bc0" [[package]] name = "proc-macro2" version = "1.0.101" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de" dependencies = [ "unicode-ident", ] [[package]] name = "quote" version = "1.0.40" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d" dependencies = [ "proc-macro2", ] [[package]] name = "ryu" version = "1.0.15" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741" [[package]] name = "serde" version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6" dependencies = [ "serde_derive", ] [[package]] name = "serde_derive" version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00" dependencies = [ "proc-macro2", "quote", "syn", ] [[package]] name = "serde_json" version = "1.0.143" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d401abef1d108fbd9cbaebc3e46611f4b1021f714a0597a71f41ee463f5f4a5a" dependencies = [ "itoa", "memchr", "ryu", "serde", ] [[package]] name = "serde_test" version = "1.0.177" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7f901ee573cab6b3060453d2d5f0bae4e6d628c23c0a962ff9b5f1d7c8d4f1ed" dependencies = [ "serde", ] [[package]] name = "syn" version = "2.0.106" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ede7c438028d4436d71104916910f5bb611972c5cfd7f89b8300a8186e6fada6" dependencies = [ "proc-macro2", "quote", "unicode-ident", ] [[package]] name = "unicode-ident" version = "1.0.11" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "301abaae475aa91687eb82514b328ab47a211a533026cb25fc3e519b86adfc3c" [[package]] name = "unty" version = "0.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6d49784317cd0d1ee7ec5c716dd598ec5b4483ea832a2dced265471cc0f690ae" [[package]] name = "virtue" version = "0.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "051eb1abcf10076295e815102942cc58f9d5e3b4560e46e53c21e8ff6f3af7b1" enum-map/Cargo.lock.license000066400000000000000000000001651510731235700161310ustar00rootroot00000000000000SPDX-FileCopyrightText: 2023 Luna Borowska SPDX-License-Identifier: CC0-1.0 or MIT OR Apache-2.0 enum-map/Cargo.toml000066400000000000000000000003221510731235700145260ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 - 2019 Luna Borowska # # SPDX-License-Identifier: CC0-1.0 or MIT OR Apache-2.0 [workspace] resolver = "2" members = [ "enum-map", "enum-map-derive", ] enum-map/LICENSES/000077500000000000000000000000001510731235700140065ustar00rootroot00000000000000enum-map/LICENSES/Apache-2.0.txt000066400000000000000000000240501510731235700162260ustar00rootroot00000000000000Apache 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. enum-map/LICENSES/CC0-1.0.txt000066400000000000000000000156101510731235700154130ustar00rootroot00000000000000Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. enum-map/LICENSES/MIT.txt000066400000000000000000000020661510731235700152040ustar00rootroot00000000000000MIT License Copyright (c) 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. enum-map/README.md000066400000000000000000000015401510731235700140600ustar00rootroot00000000000000 # enum-map A library providing enum map providing type safe enum array. It is implemented using regular Rust arrays, so using them is as fast as using regular Rust arrays. This crate follows the "N minus two" MSRV policy. This means that it supports the current Rust release, as well as the two before that. ## Examples ```rust #[macro_use] extern crate enum_map; use enum_map::EnumMap; #[derive(Debug, Enum)] enum Example { A, B, C, } fn main() { let mut map = enum_map! { Example::A => 1, Example::B => 2, Example::C => 3, }; map[Example::C] = 4; assert_eq!(map[Example::A], 1); for (key, &value) in &map { println!("{:?} has {} as value.", key, value); } } ``` enum-map/enum-map-derive/000077500000000000000000000000001510731235700155745ustar00rootroot00000000000000enum-map/enum-map-derive/Cargo.toml000066400000000000000000000014511510731235700175250ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska # SPDX-FileCopyrightText: 2018 hcpl # # SPDX-License-Identifier: MIT OR Apache-2.0 [package] name = "enum-map-derive" version = "1.0.0-beta.1" authors = ["Luna Borowska "] edition = "2024" rust-version = "1.85" repository = "https://codeberg.org/xfix/enum-map" license = "MIT OR Apache-2.0" description = "Macros 1.1 implementation of #[derive(Enum)]" keywords = ["data-structure", "no_std", "enum"] categories = ["data-structures", "no-std"] [lib] proc-macro = true [dependencies] proc-macro2 = "1.0.101" quote = "1.0.40" syn = { version = "2.0.106", default-features = false, features = ["derive", "parsing", "printing", "proc-macro"] } [dev-dependencies] enum-map = { path = "../enum-map" } enum-map/enum-map-derive/LICENSES000077700000000000000000000000001510731235700202622../LICENSESustar00rootroot00000000000000enum-map/enum-map-derive/README.md000066400000000000000000000003761510731235700170610ustar00rootroot00000000000000 # enum-map-derive This is a derive macro for `enum-map`. You don't need to specify it in dependencies as `enum-map` crate re-exports it. enum-map/enum-map-derive/src/000077500000000000000000000000001510731235700163635ustar00rootroot00000000000000enum-map/enum-map-derive/src/derive_enum.rs000066400000000000000000000152211510731235700212340ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2021 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // // SPDX-License-Identifier: MIT OR Apache-2.0 use proc_macro2::TokenStream; use quote::{ToTokens, format_ident, quote}; use syn::{DataEnum, Fields, FieldsNamed, FieldsUnnamed, Ident, Variant}; use crate::type_length; pub fn generate(name: &Ident, data_enum: &DataEnum) -> TokenStream { let mut generator = EnumGenerator::empty(); for variant in &data_enum.variants { generator.handle_variant(variant); } generator.finish(name) } #[derive(Debug)] struct Length { units: usize, opaque: TokenStream, } impl ToTokens for Length { fn to_tokens(&self, tokens: &mut TokenStream) { let Self { units, opaque } = self; tokens.extend(quote! { (#units + #opaque) }); } } /// Total length is the sum of each variant's length. To represent a variant, its number is added to /// the sum of previous variant lengths. #[derive(Debug)] struct EnumGenerator { length: Length, from_usize_arms: TokenStream, into_usize_arms: TokenStream, } impl EnumGenerator { fn empty() -> Self { Self { length: Length { units: 0, opaque: quote! { 0 }, }, from_usize_arms: quote! {}, into_usize_arms: quote! {}, } } fn finish(&self, name: &Ident) -> TokenStream { let Self { length, from_usize_arms, into_usize_arms, } = self; quote! { #[automatically_derived] impl ::enum_map::Enum for #name { type Array<__EnumMapInternalV> = [__EnumMapInternalV; #length]; #[inline] fn from_usize(value: ::enum_map::usize) -> Self { #from_usize_arms { ::enum_map::out_of_bounds() } } #[inline] fn into_usize(self) -> ::enum_map::usize { match self { #into_usize_arms } } } } } fn handle_variant(&mut self, variant: &Variant) { match &variant.fields { Fields::Unit => self.handle_unit_variant(&variant.ident), Fields::Unnamed(fields) => self.handle_unnamed_variant(&variant.ident, fields), Fields::Named(fields) => self.handle_named_variant(&variant.ident, fields), } } /// Becomes simply `1` in counting, since this is the size of the unit. fn handle_unit_variant(&mut self, variant: &Ident) { let Self { length, from_usize_arms, into_usize_arms, } = self; *into_usize_arms = quote! { #into_usize_arms Self::#variant => #length, }; *from_usize_arms = quote! { #from_usize_arms if value == #length { Self::#variant } else }; self.length.units += 1; } /// Its size is the product of the sizes of its members. To represent this variant, one can /// think of this as representing a little-endian number. First member is simply added, but /// next members are multiplied before being added. fn handle_unnamed_variant(&mut self, variant: &Ident, fields: &FieldsUnnamed) { let Self { length, from_usize_arms, into_usize_arms, } = self; let mut expr_into = quote! { #length }; let mut all_fields_length = quote! { 1usize }; let mut params_from = quote! {}; for (i, field) in fields.unnamed.iter().enumerate() { let ident = format_ident!("p{}", i); let ty = &field.ty; let field_length = type_length(ty); expr_into = quote! { (#expr_into + #all_fields_length * ::enum_map::Enum::into_usize(#ident)) }; params_from = quote! { #params_from <#ty as ::enum_map::Enum>::from_usize( (value - #length) / #all_fields_length % #field_length ), }; all_fields_length = quote! { (#all_fields_length * #field_length) }; } *length = Length { units: 0, opaque: quote! { (#length + #all_fields_length) }, }; let from_arms = &from_usize_arms; *from_usize_arms = quote! { #from_arms if value < #length { Self::#variant(#params_from) } else }; let mut params_into = quote! {}; for i in 0..fields.unnamed.len() { let ident = format_ident!("p{}", i); params_into = quote! { #params_into #ident, }; } *into_usize_arms = quote! { #into_usize_arms Self::#variant(#params_into) => #expr_into, }; } /// Its size is the product of the sizes of its members. To represent this variant, one can /// think of this as representing a little-endian number. First member is simply added, but /// next members are multiplied before being added. fn handle_named_variant(&mut self, variant: &Ident, fields: &FieldsNamed) { let Self { length, from_usize_arms, into_usize_arms, } = self; let mut expr_into = quote! { #length }; let mut all_fields_length = quote! { 1usize }; let mut params_from = quote! {}; for field in &fields.named { let ident = field.ident.as_ref().unwrap(); let ty = &field.ty; let field_length = type_length(ty); expr_into = quote! { (#expr_into + #all_fields_length * ::enum_map::Enum::into_usize(#ident)) }; params_from = quote! { #params_from #ident: <#ty as ::enum_map::Enum>::from_usize( (value - #length) / #all_fields_length % #field_length ), }; all_fields_length = quote! { (#all_fields_length * #field_length) }; } *length = Length { units: 0, opaque: quote! { (#length + #all_fields_length) }, }; *from_usize_arms = quote! { #from_usize_arms if value < #length { Self::#variant { #params_from } } else }; let mut params_into = quote! {}; for field in &fields.named { let ident = field.ident.as_ref().unwrap(); params_into = quote! { #params_into #ident, }; } *into_usize_arms = quote! { #into_usize_arms Self::#variant { #params_into } => #expr_into, }; } } enum-map/enum-map-derive/src/derive_struct.rs000066400000000000000000000074711510731235700216240ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2021 - 2022 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // // SPDX-License-Identifier: MIT OR Apache-2.0 use proc_macro2::TokenStream; use quote::quote; use syn::{DataStruct, Fields, FieldsNamed, FieldsUnnamed, Ident, Index}; use crate::type_length; pub fn generate(name: &Ident, data_struct: &DataStruct) -> TokenStream { StructGenerator::from_fields(&data_struct.fields).finish(name) } /// Total length is the product of each member's length. To represent a struct, one can /// think of this as representing a little-endian number. First member is simply added, but /// next members are multiplied before being added. #[derive(Debug)] struct StructGenerator { length: TokenStream, from_usize: TokenStream, into_usize: TokenStream, } impl StructGenerator { fn from_fields(fields: &Fields) -> Self { match fields { Fields::Unit => Self::from_unit_fields(), Fields::Unnamed(fields_data) => Self::from_unnamed_fields(fields_data), Fields::Named(fields_data) => Self::from_named_fields(fields_data), } } fn from_unit_fields() -> Self { Self { length: quote! { 1usize }, from_usize: quote! { Self }, into_usize: quote! { 0usize }, } } fn from_unnamed_fields(fields: &FieldsUnnamed) -> Self { let mut params_from = quote! {}; let mut into_usize = quote! { 0usize }; let mut length = quote! { 1usize }; for (i, field) in fields.unnamed.iter().enumerate() { let ty = &field.ty; let index_ident = Index::from(i); let field_length = type_length(ty); into_usize = quote! { (#into_usize + #length * ::enum_map::Enum::into_usize(self.#index_ident)) }; params_from = quote! { #params_from <#ty as ::enum_map::Enum>::from_usize( value / #length % #field_length ), }; length = quote! { (#length * #field_length) }; } let from_usize = quote! { Self(#params_from) }; Self { length, from_usize, into_usize, } } fn from_named_fields(fields: &FieldsNamed) -> Self { let mut params_from = quote! {}; let mut into_usize = quote! { 0usize }; let mut length = quote! { 1usize }; for field in &fields.named { let ty = &field.ty; let ident = field.ident.as_ref().unwrap(); let field_length = type_length(ty); into_usize = quote! { (#into_usize + #length * ::enum_map::Enum::into_usize(self.#ident)) }; params_from = quote! { #params_from #ident: <#ty as ::enum_map::Enum>::from_usize( value / #length % #field_length ), }; length = quote! { (#field_length * #length) }; } let from_usize = quote! { Self { #params_from } }; Self { length, from_usize, into_usize, } } fn finish(&self, name: &Ident) -> TokenStream { let length = &self.length; let from_usize = &self.from_usize; let into_usize = &self.into_usize; quote! { #[automatically_derived] impl ::enum_map::Enum for #name { type Array<__EnumMapInternalV> = [__EnumMapInternalV; #length]; #[inline] fn from_usize(value: ::enum_map::usize) -> Self { #from_usize } #[inline] fn into_usize(self) -> ::enum_map::usize { #into_usize } } } } } enum-map/enum-map-derive/src/lib.rs000066400000000000000000000122231510731235700174770ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2017 - 2022 Luna Borowska // SPDX-FileCopyrightText: 2018 hcpl // SPDX-FileCopyrightText: 2019 mara // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // SPDX-FileCopyrightText: 2021 Dietrich // // SPDX-License-Identifier: MIT OR Apache-2.0 //! Procedural macro implementing `#[derive(Enum)]` //! //! This is supposed to used with `enum-map` crate, which provides the //! actual usage documentation. mod derive_enum; mod derive_struct; use proc_macro2::TokenStream; use quote::quote; use syn::{Data, DeriveInput, Type}; /// Derive macro generating an implementation of trait `Enum`. /// /// When using a derive, enum maps are maintained in the order in which /// enum variants are declared. This is reflected in the value returned /// by `Enum::into_usize`, iterators of enum map as well as /// `EnumMap::as_slice` method. /// /// # Examples /// /// ## Enums Without Payload /// ``` /// use enum_map::Enum; /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum A { /// B, /// C, /// D, /// } /// /// assert_eq!(A::B.into_usize(), 0); /// assert_eq!(A::C.into_usize(), 1); /// assert_eq!(A::D.into_usize(), 2); /// /// assert_eq!(A::from_usize(0), A::B); /// assert_eq!(A::from_usize(1), A::C); /// assert_eq!(A::from_usize(2), A::D); /// ``` /// /// ## Enums With Payload /// /// ``` /// use enum_map::Enum; /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum A { /// B, /// C, /// D, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum X { /// Y, /// Z, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum Foo { /// Bar(bool, A), /// Empty, /// Baz { fa: A, fx: X }, /// } /// /// assert_eq!(Foo::Bar(false, A::B).into_usize(), 0); /// assert_eq!(Foo::Bar(false, A::D).into_usize(), 4); /// assert_eq!(Foo::Bar(true, A::B).into_usize(), 1); /// assert_eq!(Foo::Bar(true, A::C).into_usize(), 3); /// assert_eq!(Foo::Empty.into_usize(), 6); /// assert_eq!(Foo::Baz { fa: A::B, fx: X::Y }.into_usize(), 7); /// assert_eq!(Foo::Baz { fa: A::B, fx: X::Z }.into_usize(), 10); /// assert_eq!(Foo::Baz { fa: A::D, fx: X::Y }.into_usize(), 9); /// /// assert_eq!(Foo::from_usize(0), Foo::Bar(false, A::B)); /// assert_eq!(Foo::from_usize(4), Foo::Bar(false, A::D)); /// assert_eq!(Foo::from_usize(1), Foo::Bar(true, A::B)); /// assert_eq!(Foo::from_usize(3), Foo::Bar(true, A::C)); /// assert_eq!(Foo::from_usize(6), Foo::Empty); /// assert_eq!(Foo::from_usize(7), Foo::Baz { fa: A::B, fx: X::Y }); /// assert_eq!(Foo::from_usize(10), Foo::Baz { fa: A::B, fx: X::Z }); /// assert_eq!(Foo::from_usize(9), Foo::Baz { fa: A::D, fx: X::Y }); /// /// ``` /// /// ## Structs /// /// ``` /// use enum_map::Enum; /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum A { /// B, /// C, /// D, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum X { /// Y, /// Z, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// struct Foo { /// bar: bool, /// baz: A, /// end: X, /// } /// /// assert_eq!(Foo { bar: false, baz: A::B, end: X::Y }.into_usize(), 0); /// assert_eq!(Foo { bar: true, baz: A::B, end: X::Y }.into_usize(), 1); /// assert_eq!(Foo { bar: false, baz: A::D, end: X::Y }.into_usize(), 4); /// assert_eq!(Foo { bar: true, baz: A::C, end: X::Z }.into_usize(), 9); /// /// assert_eq!(Foo::from_usize(0), Foo { bar: false, baz: A::B, end: X::Y }); /// assert_eq!(Foo::from_usize(1), Foo { bar: true, baz: A::B, end: X::Y }); /// assert_eq!(Foo::from_usize(4), Foo { bar: false, baz: A::D, end: X::Y }); /// assert_eq!(Foo::from_usize(9), Foo { bar: true, baz: A::C, end: X::Z }); /// ``` /// /// ## Tuple Structs /// /// ``` /// use enum_map::Enum; /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum A { /// B, /// C, /// D, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// enum X { /// Y, /// Z, /// } /// /// #[derive(Enum, Debug, PartialEq, Eq)] /// struct Foo(bool, A, X); /// /// assert_eq!(Foo(false, A::B, X::Y ).into_usize(), 0); /// assert_eq!(Foo(true, A::B, X::Y ).into_usize(), 1); /// assert_eq!(Foo(false, A::D, X::Y ).into_usize(), 4); /// assert_eq!(Foo(true, A::C, X::Z ).into_usize(), 9); /// /// assert_eq!(Foo::from_usize(0), Foo(false, A::B, X::Y)); /// assert_eq!(Foo::from_usize(1), Foo(true, A::B, X::Y)); /// assert_eq!(Foo::from_usize(4), Foo(false, A::D, X::Y)); /// assert_eq!(Foo::from_usize(9), Foo(true, A::C, X::Z)); #[proc_macro_derive(Enum)] pub fn derive_enum_map(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let Ok(input) = syn::parse::(input) else { return quote! { compile_error! {"invalid #[derive(Enum)] syntax"} }.into(); }; let result = match input.data { Data::Enum(data_enum) => derive_enum::generate(&input.ident, &data_enum), Data::Struct(data_struct) => derive_struct::generate(&input.ident, &data_struct), Data::Union(_) => { quote! { compile_error! {"#[derive(Enum)] is only defined for enums and structs"} } } }; result.into() } fn type_length(ty: &Type) -> TokenStream { quote! { ::enum_map::enum_len::<#ty>() } } enum-map/enum-map/000077500000000000000000000000001510731235700143205ustar00rootroot00000000000000enum-map/enum-map/CHANGELOG.md000077700000000000000000000000001510731235700201502../CHANGELOG.mdustar00rootroot00000000000000enum-map/enum-map/Cargo.toml000066400000000000000000000026651510731235700162610ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska # SPDX-FileCopyrightText: 2021 Alex Sayers # # SPDX-License-Identifier: MIT OR Apache-2.0 [package] name = "enum-map" version = "3.0.0-beta.2" authors = ["Luna Borowska "] edition = "2024" rust-version = "1.85" repository = "https://codeberg.org/xfix/enum-map" license = "MIT OR Apache-2.0" description = "A map with C-like enum keys represented internally as an array" keywords = ["data-structure", "no_std", "enum"] categories = ["data-structures", "no-std"] documentation = "https://docs.rs/enum-map" readme = "README.md" [dependencies] arbitrary = { version = "1.4.2", optional = true } borsh = { version = "1.5.7", default-features = false, optional = true } bytemuck = { version = "1.23.2", optional = true } enum-map-derive = { version = "=1.0.0-beta.1", path = "../enum-map-derive", optional = true } serde = { version = "1.0.219", optional = true, default-features = false } [dev-dependencies] bincode = { version = "2.0.1", features = ["serde"] } enum-map-derive = { path = "../enum-map-derive" } serde = { version = "1.0.219", features = ["derive"] } serde_test = "1.0.177" serde_json = "1.0.143" [package.metadata.docs.rs] features = ["arbitrary", "bytemuck", "serde"] [features] default = ["derive"] arbitrary = ["dep:arbitrary"] borsh = ["dep:borsh"] bytemuck = ["dep:bytemuck"] derive = ["dep:enum-map-derive"] serde = ["dep:serde"] enum-map/enum-map/LICENSES000077700000000000000000000000001510731235700170062../LICENSESustar00rootroot00000000000000enum-map/enum-map/README.md000077700000000000000000000000001510731235700172642../README.mdustar00rootroot00000000000000enum-map/enum-map/src/000077500000000000000000000000001510731235700151075ustar00rootroot00000000000000enum-map/enum-map/src/arbitrary.rs000066400000000000000000000016501510731235700174560ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2021 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::internal::Array; use crate::{Enum, EnumMap, enum_map}; use arbitrary::{Arbitrary, Result, Unstructured}; /// Requires crate feature `"arbitrary"` impl<'a, K: Enum, V: Arbitrary<'a>> Arbitrary<'a> for EnumMap { fn arbitrary(u: &mut Unstructured<'a>) -> Result> { Ok(enum_map! { _ => Arbitrary::arbitrary(u)?, }) } fn size_hint(depth: usize) -> (usize, Option) { let len = K::Array::::LENGTH; if len == 0 { (0, Some(0)) } else { let (lo, hi) = V::size_hint(depth); ( lo.saturating_mul(len), hi.and_then(|hi| hi.checked_mul(len)), ) } } } enum-map/enum-map/src/borsh.rs000066400000000000000000000015771510731235700166040ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2023 Mateusz Kowalczyk // // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::{Enum, EnumMap}; use borsh::{BorshDeserialize, BorshSerialize}; /// Requires crate feature `"borsh"` impl BorshSerialize for EnumMap where K: Enum, ::Array: BorshSerialize, { fn serialize(&self, writer: &mut W) -> borsh::io::Result<()> { <::Array as BorshSerialize>::serialize(&self.array, writer) } } /// Requires crate feature `"borsh"` impl BorshDeserialize for EnumMap where K: Enum, ::Array: BorshDeserialize, { fn deserialize_reader(reader: &mut R) -> borsh::io::Result { <::Array as BorshDeserialize>::deserialize_reader(reader) .map(|array| Self { array }) } } enum-map/enum-map/src/bytemuck.rs000066400000000000000000000011561510731235700173030ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2024 +merlan #flirora // // SPDX-License-Identifier: MIT OR Apache-2.0 use bytemuck::{Pod, TransparentWrapper, Zeroable}; use crate::{Enum, EnumMap}; // SAFETY: `EnumMap` is a transparent wrapper around `K::Array`, so // any layout property that applies to `K::Array` also applies to // `EnumMap`. unsafe impl Pod for EnumMap where K::Array: Pod {} unsafe impl TransparentWrapper> for EnumMap {} unsafe impl Zeroable for EnumMap where K::Array: Zeroable {} enum-map/enum-map/src/enum_map_impls.rs000066400000000000000000000056361510731235700204740ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // SPDX-FileCopyrightText: 2021 micycle // SPDX-FileCopyrightText: 2023 Nicolas Carranza // // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::{Enum, EnumMap, enum_map}; use core::fmt::{self, Debug, Formatter}; use core::hash::{Hash, Hasher}; use core::iter::{Extend, FromIterator}; use core::ops::{Index, IndexMut}; impl Debug for EnumMap { fn fmt(&self, f: &mut Formatter) -> fmt::Result { f.debug_map().entries(self).finish() } } impl Extend<(K, V)> for EnumMap { fn extend>(&mut self, iter: I) { for (key, value) in iter { self[key] = value; } } } impl<'a, K, V> Extend<(&'a K, &'a V)> for EnumMap where K: Enum + Copy, V: Copy, { fn extend>(&mut self, iter: I) { self.extend(iter.into_iter().map(|(&key, &value)| (key, value))); } } impl FromIterator<(K, V)> for EnumMap where Self: Default, K: Enum, { fn from_iter>(iter: I) -> Self { let mut map = EnumMap::default(); map.extend(iter); map } } impl Index for EnumMap { type Output = V; #[inline] fn index(&self, key: K) -> &V { &self.as_slice()[key.into_usize()] } } impl IndexMut for EnumMap { #[inline] fn index_mut(&mut self, key: K) -> &mut V { &mut self.as_mut_slice()[key.into_usize()] } } // Implementations provided by derive attribute are too specific, and put requirements on K. // This is caused by rust-lang/rust#26925. impl Clone for EnumMap where K::Array: Clone, { #[inline] fn clone(&self) -> Self { EnumMap { array: self.array.clone(), } } } impl Copy for EnumMap where K::Array: Copy {} impl PartialEq for EnumMap { #[inline] fn eq(&self, other: &Self) -> bool { self.as_slice() == other.as_slice() } } impl Eq for EnumMap {} impl Hash for EnumMap { #[inline] fn hash(&self, state: &mut H) { self.as_slice().hash(state); } } impl Default for EnumMap { #[inline] fn default() -> Self { enum_map! { _ => V::default() } } } impl PartialOrd for EnumMap { fn partial_cmp(&self, other: &Self) -> Option { self.as_slice().partial_cmp(other.as_slice()) } } impl Ord for EnumMap { fn cmp(&self, other: &Self) -> core::cmp::Ordering { self.as_slice().cmp(other.as_slice()) } } enum-map/enum-map/src/internal.rs000066400000000000000000000061501510731235700172730ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // SPDX-FileCopyrightText: 2022 philipp // // SPDX-License-Identifier: MIT OR Apache-2.0 use core::cmp::Ordering; use core::convert::Infallible; /// Enum mapping type. /// /// This trait is implemented by `#[derive(Enum)]`. /// /// This trait is also implemented by `bool` and `u8`. While `u8` is /// strictly speaking not an actual enum, there are good reasons to consider /// it like one, as array of `u8` keys is a relatively common pattern. pub trait Enum: Sized { /// Representation of an enum. /// /// For an enum with four elements it looks like this. /// /// ``` /// type Array = [V; 4]; /// ``` type Array: Array; /// Takes an usize, and returns an element matching `into_usize` function. fn from_usize(value: usize) -> Self; /// Returns an unique identifier for a value within range of `0..Array::LENGTH`. fn into_usize(self) -> usize; } /// Array for enum-map storage. /// /// This trait is inteded for primitive array types (with fixed length). /// /// # Safety /// /// The array length needs to match actual storage. pub unsafe trait Array { // This is necessary duplication because the length in Enum trait can be // provided by user and may not be trustworthy for unsafe code. const LENGTH: usize; } unsafe impl Array for [V; N] { const LENGTH: usize = N; } #[doc(hidden)] #[inline] pub fn out_of_bounds() -> ! { panic!("index out of range for Enum::from_usize"); } impl Enum for bool { type Array = [V; 2]; #[inline] fn from_usize(value: usize) -> Self { match value { 0 => false, 1 => true, _ => out_of_bounds(), } } #[inline] fn into_usize(self) -> usize { usize::from(self) } } impl Enum for () { type Array = [V; 1]; #[inline] fn from_usize(value: usize) -> Self { match value { 0 => (), _ => out_of_bounds(), } } #[inline] fn into_usize(self) -> usize { 0 } } impl Enum for u8 { type Array = [V; 256]; #[inline] fn from_usize(value: usize) -> Self { value.try_into().unwrap_or_else(|_| out_of_bounds()) } #[inline] fn into_usize(self) -> usize { usize::from(self) } } impl Enum for Infallible { type Array = [V; 0]; #[inline] fn from_usize(_: usize) -> Self { out_of_bounds(); } #[inline] fn into_usize(self) -> usize { match self {} } } impl Enum for Ordering { type Array = [V; 3]; #[inline] fn from_usize(value: usize) -> Self { match value { 0 => Ordering::Less, 1 => Ordering::Equal, 2 => Ordering::Greater, _ => out_of_bounds(), } } #[inline] fn into_usize(self) -> usize { match self { Ordering::Less => 0, Ordering::Equal => 1, Ordering::Greater => 2, } } } enum-map/enum-map/src/iter.rs000066400000000000000000000241001510731235700164150ustar00rootroot00000000000000#![allow(clippy::module_name_repetitions)] // SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2020 Amanieu d'Antras // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::{Enum, EnumMap}; use core::iter::{Enumerate, FusedIterator}; use core::marker::PhantomData; use core::mem::ManuallyDrop; use core::ops::Range; use core::ptr; use core::slice; /// Immutable enum map iterator /// /// This struct is created by `iter` method or `into_iter` on a reference /// to `EnumMap`. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum)] /// enum Example { /// A, /// B, /// C, /// } /// /// let mut map = enum_map! { Example::A => 3, _ => 0 }; /// assert_eq!(map[Example::A], 3); /// for (key, &value) in &map { /// assert_eq!(value, match key { /// Example::A => 3, /// _ => 0, /// }); /// } /// ``` #[derive(Debug)] pub struct Iter<'a, K, V: 'a> { _phantom: PhantomData K>, iterator: Enumerate>, } impl Clone for Iter<'_, K, V> { fn clone(&self) -> Self { Iter { _phantom: PhantomData, iterator: self.iterator.clone(), } } } impl<'a, K: Enum, V> Iterator for Iter<'a, K, V> { type Item = (K, &'a V); #[inline] fn next(&mut self) -> Option { self.iterator .next() .map(|(index, item)| (K::from_usize(index), item)) } #[inline] fn size_hint(&self) -> (usize, Option) { self.iterator.size_hint() } fn fold(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B, { self.iterator .map(|(index, item)| (K::from_usize(index), item)) .fold(init, f) } } impl DoubleEndedIterator for Iter<'_, K, V> { #[inline] fn next_back(&mut self) -> Option { self.iterator .next_back() .map(|(index, item)| (K::from_usize(index), item)) } } impl ExactSizeIterator for Iter<'_, K, V> {} impl FusedIterator for Iter<'_, K, V> {} impl<'a, K: Enum, V> IntoIterator for &'a EnumMap { type Item = (K, &'a V); type IntoIter = Iter<'a, K, V>; #[inline] fn into_iter(self) -> Self::IntoIter { Iter { _phantom: PhantomData, iterator: self.as_slice().iter().enumerate(), } } } /// Mutable map iterator /// /// This struct is created by `iter_mut` method or `into_iter` on a mutable /// reference to `EnumMap`. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Debug, Enum)] /// enum Example { /// A, /// B, /// C, /// } /// /// let mut map = enum_map! { Example::A => 3, _ => 0 }; /// for (_, value) in &mut map { /// *value += 1; /// } /// assert_eq!(map, enum_map! { Example::A => 4, _ => 1 }); /// ``` #[derive(Debug)] pub struct IterMut<'a, K, V: 'a> { _phantom: PhantomData K>, iterator: Enumerate>, } impl<'a, K: Enum, V> Iterator for IterMut<'a, K, V> { type Item = (K, &'a mut V); #[inline] fn next(&mut self) -> Option { self.iterator .next() .map(|(index, item)| (K::from_usize(index), item)) } #[inline] fn size_hint(&self) -> (usize, Option) { self.iterator.size_hint() } fn fold(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B, { self.iterator .map(|(index, item)| (K::from_usize(index), item)) .fold(init, f) } } impl DoubleEndedIterator for IterMut<'_, K, V> { #[inline] fn next_back(&mut self) -> Option { self.iterator .next_back() .map(|(index, item)| (K::from_usize(index), item)) } } impl ExactSizeIterator for IterMut<'_, K, V> {} impl FusedIterator for IterMut<'_, K, V> {} impl<'a, K: Enum, V> IntoIterator for &'a mut EnumMap { type Item = (K, &'a mut V); type IntoIter = IterMut<'a, K, V>; #[inline] fn into_iter(self) -> Self::IntoIter { IterMut { _phantom: PhantomData, iterator: self.as_mut_slice().iter_mut().enumerate(), } } } /// A map iterator that moves out of map. /// /// This struct is created by `into_iter` on `EnumMap`. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Debug, Enum)] /// enum Example { /// A, /// B, /// } /// /// let map = enum_map! { Example::A | Example::B => String::from("123") }; /// for (_, value) in map { /// assert_eq!(value + "4", "1234"); /// } /// ``` pub struct IntoIter { map: ManuallyDrop>, alive: Range, } impl Iterator for IntoIter { type Item = (K, V); fn next(&mut self) -> Option<(K, V)> { let position = self.alive.next()?; Some((K::from_usize(position), unsafe { ptr::read(&raw const self.map.as_slice()[position]) })) } #[inline] fn size_hint(&self) -> (usize, Option) { self.alive.size_hint() } } impl DoubleEndedIterator for IntoIter { fn next_back(&mut self) -> Option<(K, V)> { let position = self.alive.next_back()?; Some((K::from_usize(position), unsafe { ptr::read(&raw const self.map.as_slice()[position]) })) } } impl ExactSizeIterator for IntoIter {} impl FusedIterator for IntoIter {} impl Drop for IntoIter { #[inline] fn drop(&mut self) { unsafe { ptr::drop_in_place(&raw mut self.map.as_mut_slice()[self.alive.clone()]); } } } impl IntoIterator for EnumMap { type Item = (K, V); type IntoIter = IntoIter; #[inline] fn into_iter(self) -> Self::IntoIter { let len = self.len(); IntoIter { map: ManuallyDrop::new(self), alive: 0..len, } } } impl EnumMap { /// An iterator visiting all values. The iterator type is `&V`. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let map = enum_map! { false => 3, true => 4 }; /// let mut values = map.values(); /// assert_eq!(values.next(), Some(&3)); /// assert_eq!(values.next(), Some(&4)); /// assert_eq!(values.next(), None); /// ``` #[inline] pub fn values(&self) -> Values<'_, V> { Values(self.as_slice().iter()) } /// An iterator visiting all values mutably. The iterator type is `&mut V`. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let mut map = enum_map! { _ => 2 }; /// for value in map.values_mut() { /// *value += 2; /// } /// assert_eq!(map[false], 4); /// assert_eq!(map[true], 4); /// ``` #[inline] pub fn values_mut(&mut self) -> ValuesMut<'_, V> { ValuesMut(self.as_mut_slice().iter_mut()) } /// Creates a consuming iterator visiting all the values. The map /// cannot be used after calling this. The iterator element type /// is `V`. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let mut map = enum_map! { false => "hello", true => "goodbye" }; /// assert_eq!(map.into_values().collect::>(), ["hello", "goodbye"]); /// ``` #[inline] pub fn into_values(self) -> IntoValues { IntoValues { inner: self.into_iter(), } } } /// An iterator over the values of `EnumMap`. /// /// This `struct` is created by the `values` method of `EnumMap`. /// See its documentation for more. pub struct Values<'a, V: 'a>(slice::Iter<'a, V>); impl Clone for Values<'_, V> { fn clone(&self) -> Self { Values(self.0.clone()) } } impl<'a, V: 'a> Iterator for Values<'a, V> { type Item = &'a V; #[inline] fn next(&mut self) -> Option<&'a V> { self.0.next() } #[inline] fn size_hint(&self) -> (usize, Option) { self.0.size_hint() } } impl<'a, V: 'a> DoubleEndedIterator for Values<'a, V> { #[inline] fn next_back(&mut self) -> Option<&'a V> { self.0.next_back() } } impl<'a, V: 'a> ExactSizeIterator for Values<'a, V> {} impl<'a, V: 'a> FusedIterator for Values<'a, V> {} /// A mutable iterator over the values of `EnumMap`. /// /// This `struct` is created by the `values_mut` method of `EnumMap`. /// See its documentation for more. pub struct ValuesMut<'a, V: 'a>(slice::IterMut<'a, V>); impl<'a, V: 'a> Iterator for ValuesMut<'a, V> { type Item = &'a mut V; #[inline] fn next(&mut self) -> Option<&'a mut V> { self.0.next() } #[inline] fn size_hint(&self) -> (usize, Option) { self.0.size_hint() } } impl<'a, V: 'a> DoubleEndedIterator for ValuesMut<'a, V> { #[inline] fn next_back(&mut self) -> Option<&'a mut V> { self.0.next_back() } } impl<'a, V: 'a> ExactSizeIterator for ValuesMut<'a, V> {} impl<'a, V: 'a> FusedIterator for ValuesMut<'a, V> {} /// An owning iterator over the values of an `EnumMap`. /// /// This `struct` is created by the `into_values` method of `EnumMap`. /// See its documentation for more. pub struct IntoValues { inner: IntoIter, } impl Iterator for IntoValues where K: Enum, { type Item = V; fn next(&mut self) -> Option { Some(self.inner.next()?.1) } fn size_hint(&self) -> (usize, Option) { self.inner.size_hint() } } impl DoubleEndedIterator for IntoValues { fn next_back(&mut self) -> Option { Some(self.inner.next_back()?.1) } } impl ExactSizeIterator for IntoValues where K: Enum {} impl FusedIterator for IntoValues where K: Enum {} enum-map/enum-map/src/lib.rs000066400000000000000000000370721510731235700162340ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2019 Riey // SPDX-FileCopyrightText: 2021 Alex Sayers // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // SPDX-FileCopyrightText: 2022 Cass Fridkin // SPDX-FileCopyrightText: 2022 Mateusz Kowalczyk // // SPDX-License-Identifier: MIT OR Apache-2.0 //! An enum mapping type. //! //! It is implemented using an array type, so using it is as fast as using Rust //! arrays. //! //! # Examples //! //! ``` //! # use enum_map_derive::*; //! use enum_map::{enum_map, Enum, EnumMap}; //! //! #[derive(Debug, Enum)] //! enum Example { //! A(bool), //! B, //! C, //! } //! //! let mut map = enum_map! { //! Example::A(false) => 0, //! Example::A(true) => 1, //! Example::B => 2, //! Example::C => 3, //! }; //! map[Example::C] = 4; //! //! assert_eq!(map[Example::A(true)], 1); //! //! for (key, &value) in &map { //! println!("{:?} has {} as value.", key, value); //! } //! ``` #![no_std] #![deny(missing_docs)] #![warn(clippy::pedantic)] #[cfg(feature = "arbitrary")] mod arbitrary; #[cfg(feature = "borsh")] mod borsh; #[cfg(feature = "bytemuck")] mod bytemuck; mod enum_map_impls; mod internal; mod iter; #[cfg(feature = "serde")] mod serde; #[doc(hidden)] pub use core::mem::{self, ManuallyDrop, MaybeUninit}; #[doc(hidden)] pub use core::primitive::usize; use core::{convert::Infallible, slice}; #[doc(hidden)] // unreachable needs to be exported for compatibility with older versions of enum-map-derive pub use core::{panic, ptr, unreachable}; #[cfg(feature = "derive")] pub use enum_map_derive::Enum; use internal::Array; pub use internal::Enum; #[doc(hidden)] pub use internal::out_of_bounds; pub use iter::{IntoIter, IntoValues, Iter, IterMut, Values, ValuesMut}; // SAFETY: initialized needs to represent number of initialized elements #[doc(hidden)] pub struct Guard<'a, K, V> where K: Enum, { array_mut: &'a mut MaybeUninit>, initialized: usize, } impl Drop for Guard<'_, K, V> where K: Enum, { fn drop(&mut self) { // This is safe as arr[..len] is initialized due to // Guard's type invariant. unsafe { ptr::slice_from_raw_parts_mut(self.as_mut_ptr(), self.initialized).drop_in_place(); } } } impl<'a, K, V> Guard<'a, K, V> where K: Enum, { #[doc(hidden)] pub fn as_mut_ptr(&mut self) -> *mut V { self.array_mut.as_mut_ptr().cast::() } #[doc(hidden)] #[must_use] pub fn new(array_mut: &'a mut MaybeUninit>) -> Self { Self { array_mut, initialized: 0, } } #[doc(hidden)] #[must_use] #[allow(clippy::unused_self)] pub fn storage_length(&self) -> usize { // SAFETY: We need to use LENGTH from K::Array, as K::LENGTH is // untrustworthy. K::Array::::LENGTH } #[doc(hidden)] #[must_use] pub fn get_key(&self) -> K { K::from_usize(self.initialized) } #[doc(hidden)] // Unsafe as it can write out of bounds. pub unsafe fn push(&mut self, value: V) { unsafe { self.as_mut_ptr().add(self.initialized).write(value); } self.initialized += 1; } } #[doc(hidden)] pub struct TypeEqualizer<'a, K, V> where K: Enum, { pub enum_map: [EnumMap; 0], pub guard: Guard<'a, K, V>, } /// Enum map constructor. /// /// This macro allows to create a new enum map in a type safe way. It takes /// a list of `,` separated pairs separated by `=>`. Left side is `|` /// separated list of enum keys, or `_` to match all unmatched enum keys, /// while right side is a value. /// /// The iteration order when using this macro is not guaranteed to be /// consistent. Future releases of this crate may change it, and this is not /// considered to be a breaking change. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum)] /// enum Example { /// A, /// B, /// C, /// D, /// } /// /// let enum_map = enum_map! { /// Example::A | Example::B => 1, /// Example::C => 2, /// _ => 3, /// }; /// assert_eq!(enum_map[Example::A], 1); /// assert_eq!(enum_map[Example::B], 1); /// assert_eq!(enum_map[Example::C], 2); /// assert_eq!(enum_map[Example::D], 3); /// ``` #[macro_export] macro_rules! enum_map { {$($t:tt)*} => {{ let mut uninit = $crate::MaybeUninit::uninit(); let mut eq = $crate::TypeEqualizer { enum_map: [], guard: $crate::Guard::new(&mut uninit), }; if false { // Safe because this code is unreachable unsafe { (&mut eq.enum_map).as_mut_ptr().read() } } else { for _ in 0..(&eq.guard).storage_length() { struct __PleaseDoNotUseBreakWithoutLabel; let _please_do_not_use_continue_without_label; let value; #[allow(unreachable_code)] loop { _please_do_not_use_continue_without_label = (); value = match (&eq.guard).get_key() { $($t)* }; break __PleaseDoNotUseBreakWithoutLabel; }; unsafe { (&mut eq.guard).push(value); } } #[allow(clippy::mem_forget, reason = "avoid Drop impl on Guard on success")] $crate::mem::forget(eq); // Safe because the array was fully initialized. $crate::EnumMap::from_array(unsafe { uninit.assume_init() }) } }}; } /// An enum mapping. /// /// This internally uses an array which stores a value for each possible /// enum value. To work, it requires implementation of internal (private, /// although public due to macro limitations) trait which allows extracting /// information about an enum, which can be automatically generated using /// `#[derive(Enum)]` macro. /// /// Additionally, `bool` and `u8` automatically derives from `Enum`. While /// `u8` is not technically an enum, it's convenient to consider it like one. /// In particular, [reverse-complement in benchmark game] could be using `u8` /// as an enum. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum, EnumMap}; /// /// #[derive(Enum)] /// enum Example { /// A, /// B, /// C, /// } /// /// let mut map = EnumMap::default(); /// // new initializes map with default values /// assert_eq!(map[Example::A], 0); /// map[Example::A] = 3; /// assert_eq!(map[Example::A], 3); /// ``` /// /// [reverse-complement in benchmark game]: /// http://benchmarksgame.alioth.debian.org/u64q/program.php?test=revcomp&lang=rust&id=2 #[repr(transparent)] pub struct EnumMap { array: K::Array, } impl EnumMap { /// Clear enum map with default values. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{Enum, EnumMap}; /// /// #[derive(Enum)] /// enum Example { /// A, /// B, /// } /// /// let mut enum_map = EnumMap::<_, String>::default(); /// enum_map[Example::B] = "foo".into(); /// enum_map.clear(); /// assert_eq!(enum_map[Example::A], ""); /// assert_eq!(enum_map[Example::B], ""); /// ``` #[inline] pub fn clear(&mut self) { for v in self.as_mut_slice() { *v = V::default(); } } } #[allow(clippy::len_without_is_empty)] impl EnumMap { /// Creates an enum map from array. #[inline] pub const fn from_array(array: K::Array) -> EnumMap { EnumMap { array } } /// Create an enum map, where each value is the returned value from `cb` /// using provided enum key. /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum, EnumMap}; /// /// #[derive(Enum, PartialEq, Debug)] /// enum Example { /// A, /// B, /// } /// /// let map = EnumMap::from_fn(|k| k == Example::A); /// assert_eq!(map, enum_map! { Example::A => true, Example::B => false }) /// ``` pub fn from_fn(mut cb: F) -> Self where F: FnMut(K) -> V, { enum_map! { k => cb(k) } } /// Create an enum map, where each value is the returned value of /// fallible function `cb`, using provided enum key. /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum, EnumMap}; /// /// #[derive(Enum, PartialEq, Debug)] /// enum Example { /// A, /// B, /// } /// /// let map = EnumMap::try_from_fn(|k: Example| { /// if k == Example::A { /// Ok(4) /// } else { /// Err("error") /// } /// }); /// assert_eq!(map, Err("error")) /// ``` /// /// # Errors /// /// This returns any errors that `cb` generates. pub fn try_from_fn(mut cb: F) -> Result where F: FnMut(K) -> Result, { Ok(enum_map! { k => cb(k)? }) } /// Returns an iterator over enum map. /// /// The iteration order is deterministic, and when using [macro@Enum] derive /// it will be the order in which enum variants are declared. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum, PartialEq)] /// enum E { /// A, /// B, /// C, /// } /// /// let map = enum_map! { E::A => 1, E::B => 2, E::C => 3}; /// assert!(map.iter().eq([(E::A, &1), (E::B, &2), (E::C, &3)])); /// ``` #[inline] pub fn iter(&self) -> Iter<'_, K, V> { self.into_iter() } /// Returns a mutable iterator over enum map. #[inline] pub fn iter_mut(&mut self) -> IterMut<'_, K, V> { self.into_iter() } /// Returns number of elements in enum map. #[inline] #[allow(clippy::unused_self)] pub const fn len(&self) -> usize { K::Array::::LENGTH } /// Swaps two indexes. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let mut map = enum_map! { false => 0, true => 1 }; /// map.swap(false, true); /// assert_eq!(map[false], 1); /// assert_eq!(map[true], 0); /// ``` #[inline] pub fn swap(&mut self, a: K, b: K) { self.as_mut_slice().swap(a.into_usize(), b.into_usize()); } /// Consumes an enum map and returns the underlying array. /// /// The order of elements is deterministic, and when using [macro@Enum] /// derive it will be the order in which enum variants are declared. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum, PartialEq)] /// enum E { /// A, /// B, /// C, /// } /// /// let map = enum_map! { E::A => 1, E::B => 2, E::C => 3}; /// assert_eq!(map.into_array(), [1, 2, 3]); /// ``` pub fn into_array(self) -> K::Array { self.array } /// Returns a reference to the underlying array. /// /// The order of elements is deterministic, and when using [macro@Enum] /// derive it will be the order in which enum variants are declared. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum, PartialEq)] /// enum E { /// A, /// B, /// C, /// } /// /// let map = enum_map! { E::A => 1, E::B => 2, E::C => 3}; /// assert_eq!(map.as_array(), &[1, 2, 3]); /// ``` pub const fn as_array(&self) -> &K::Array { &self.array } /// Returns a mutable reference to the underlying array. /// /// The order of elements is deterministic, and when using [macro@Enum] /// derive it will be the order in which enum variants are declared. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum, PartialEq)] /// enum E { /// A, /// B, /// C, /// } /// /// let mut map = enum_map! { E::A => 1, E::B => 2, E::C => 3}; /// map.as_mut_array()[1] = 42; /// assert_eq!(map.as_array(), &[1, 42, 3]); /// ``` pub fn as_mut_array(&mut self) -> &mut K::Array { &mut self.array } /// Converts an enum map to a slice representing values. /// /// The order of elements is deterministic, and when using [macro@Enum] /// derive it will be the order in which enum variants are declared. /// /// # Examples /// /// ``` /// # use enum_map_derive::*; /// use enum_map::{enum_map, Enum}; /// /// #[derive(Enum, PartialEq)] /// enum E { /// A, /// B, /// C, /// } /// /// let map = enum_map! { E::A => 1, E::B => 2, E::C => 3}; /// assert_eq!(map.as_slice(), &[1, 2, 3]); /// ``` #[inline] pub fn as_slice(&self) -> &[V] { unsafe { slice::from_raw_parts(ptr::addr_of!(self.array).cast(), K::Array::::LENGTH) } } /// Converts a mutable enum map to a mutable slice representing values. #[inline] pub fn as_mut_slice(&mut self) -> &mut [V] { unsafe { slice::from_raw_parts_mut(ptr::addr_of_mut!(self.array).cast(), K::Array::::LENGTH) } } /// Returns an enum map with function `f` applied to each element in order. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let a = enum_map! { false => 0, true => 1 }; /// let b = a.map(|_, x| f64::from(x) + 0.5); /// assert_eq!(b, enum_map! { false => 0.5, true => 1.5 }); /// ``` #[expect(clippy::missing_panics_doc, reason = "This uses an infallible closure")] pub fn map(self, mut f: F) -> EnumMap where F: FnMut(K, V) -> T, K: Enum, { self.try_map(|k, v| Ok::<_, Infallible>(f(k, v))).unwrap() } /// Applies fallible function `f` to each element of enum map returning /// an enum map of the same key type as `self` or the first error /// encountered. /// /// # Examples /// /// ``` /// use enum_map::enum_map; /// /// let a = enum_map! { false => 0, true => 400 }; /// let b = a.try_map(|_, x| u8::try_from(x)); /// assert!(b.is_err()); /// ``` /// /// # Errors /// /// This returns any errors that `f` generates. pub fn try_map(self, mut f: F) -> Result, E> where F: FnMut(K, V) -> Result, K: Enum, { struct DropOnPanic where K: Enum, { position: usize, map: ManuallyDrop>, } impl Drop for DropOnPanic where K: Enum, { fn drop(&mut self) { unsafe { ptr::drop_in_place(&raw mut self.map.as_mut_slice()[self.position..]); } } } let mut drop_protect = DropOnPanic { position: 0, map: ManuallyDrop::new(self), }; Ok(enum_map! { k => { let value = unsafe { ptr::read(&raw const drop_protect.map.as_slice()[drop_protect.position]) }; drop_protect.position += 1; f(k, value)? } }) } } #[doc(hidden)] #[must_use] pub const fn enum_len() -> usize { E::Array::<()>::LENGTH } enum-map/enum-map/src/serde.rs000066400000000000000000000062661510731235700165710ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2017 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::internal::Array; use crate::{Enum, EnumMap, enum_map}; use core::fmt; use core::marker::PhantomData; use serde::de::{self, Deserialize, Deserializer, Error, MapAccess, SeqAccess}; use serde::ser::{Serialize, SerializeTuple, Serializer}; /// Requires crate feature `"serde"` impl Serialize for EnumMap { fn serialize(&self, serializer: S) -> Result { if serializer.is_human_readable() { serializer.collect_map(self) } else { let mut tup = serializer.serialize_tuple(self.len())?; for value in self.values() { tup.serialize_element(value)?; } tup.end() } } } /// Requires crate feature `"serde"` impl<'de, K, V> Deserialize<'de> for EnumMap where K: Enum + Deserialize<'de>, V: Deserialize<'de>, { fn deserialize>(deserializer: D) -> Result { if deserializer.is_human_readable() { deserializer.deserialize_map(HumanReadableVisitor(PhantomData)) } else { deserializer.deserialize_tuple(K::Array::::LENGTH, CompactVisitor(PhantomData)) } } } struct HumanReadableVisitor(PhantomData<(K, V)>); impl<'de, K, V> de::Visitor<'de> for HumanReadableVisitor where K: Enum + Deserialize<'de>, V: Deserialize<'de>, { type Value = EnumMap; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { write!(formatter, "a map") } fn visit_map>(self, mut access: M) -> Result { let mut entries = EnumMap::default(); while let Some((key, value)) = access.next_entry()? { entries[key] = Some(value); } for value in entries.values() { value .as_ref() .ok_or_else(|| M::Error::custom("key not specified"))?; } Ok(enum_map! { key => entries[key].take().unwrap() }) } } struct CompactVisitor(PhantomData<(K, V)>); impl<'de, K, V> de::Visitor<'de> for CompactVisitor where K: Enum + Deserialize<'de>, V: Deserialize<'de>, { type Value = EnumMap; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { write!(formatter, "a sequence") } fn visit_seq>(self, mut access: M) -> Result { let mut entries = EnumMap::default(); let len = entries.len(); { let mut iter = entries.values_mut(); while let Some(place) = iter.next() { *place = Some(access.next_element()?.ok_or_else(|| { M::Error::invalid_length( len - iter.len() - 1, &"a sequence with as many elements as there are variants", ) })?); } } Ok(enum_map! { key => entries[key].take().unwrap() }) } } enum-map/enum-map/tests/000077500000000000000000000000001510731235700154625ustar00rootroot00000000000000enum-map/enum-map/tests/borsh.rs000066400000000000000000000014741510731235700171530ustar00rootroot00000000000000#![cfg(feature = "borsh")] // SPDX-FileCopyrightText: 2023 Mateusz Kowalczyk // // SPDX-License-Identifier: MIT OR Apache-2.0 #![warn(clippy::pedantic)] use enum_map::enum_map; use enum_map_derive::Enum; use serde::{Deserialize, Serialize}; #[derive(Debug, Enum, Deserialize, Serialize, PartialEq)] enum Inner { One, Two, Three, } #[derive(Debug, Enum, Deserialize, Serialize, PartialEq)] enum Example { A, B(Inner), C, } #[test] fn round_trip() { let map = enum_map! { Example::A => 5, Example::B(Inner::One) => 10, Example::B(Inner::Two) => 11, Example::B(Inner::Three) => 12, Example::C => 42, }; let ser = borsh::to_vec(&map).unwrap(); let deser = borsh::from_slice(&ser).unwrap(); assert_eq!(map, deser); } enum-map/enum-map/tests/serde.rs000066400000000000000000000064351510731235700171420ustar00rootroot00000000000000#![cfg(feature = "serde")] // SPDX-FileCopyrightText: 2017 - 2022 Kamila Borowska // SPDX-FileCopyrightText: 2022 Cass Fridkin // // SPDX-License-Identifier: MIT OR Apache-2.0 #![warn(clippy::pedantic)] use enum_map::{EnumMap, enum_map}; use enum_map_derive::Enum; use serde::{Deserialize, Serialize}; use serde_test::{Compact, Configure, Token, assert_de_tokens_error, assert_tokens}; #[derive(Debug, Enum, Deserialize, Serialize)] enum Example { A, B, } #[test] fn serialization() { let map = enum_map! { Example::A => 5, Example::B => 10 }; assert_tokens( &map.readable(), &[ Token::Map { len: Some(2) }, Token::UnitVariant { name: "Example", variant: "A", }, Token::I32(5), Token::UnitVariant { name: "Example", variant: "B", }, Token::I32(10), Token::MapEnd, ], ); } #[test] fn compact_serialization() { let map = enum_map! { Example::A => 5, Example::B => 10 }; assert_tokens( &map.compact(), &[ Token::Tuple { len: 2 }, Token::I32(5), Token::I32(10), Token::TupleEnd, ], ); } #[test] fn invalid_compact_deserialization() { assert_de_tokens_error::>>( &[Token::I32(4)], "invalid type: integer `4`, expected a sequence", ); } #[test] fn too_short_compact_deserialization() { assert_de_tokens_error::>>( &[Token::Seq { len: None }, Token::Bool(true), Token::SeqEnd], "invalid length 1, expected a sequence with as many elements as there are variants", ); } const JSON: &str = r#"{"A":5,"B":10}"#; #[test] fn json_serialization() { let map = enum_map! { Example::A => 5, Example::B => 10 }; assert_eq!(serde_json::to_string(&map).unwrap(), String::from(JSON)); } #[test] fn json_deserialization() { let example: EnumMap = serde_json::from_str(JSON).unwrap(); assert_eq!(example, enum_map! { Example::A => 5, Example::B => 10 }); } #[test] fn json_invalid_deserialization() { let example: Result, _> = serde_json::from_str(r"{}"); assert!(example.is_err()); } #[test] fn json_invalid_type() { let example: Result, _> = serde_json::from_str("4"); assert!(example.is_err()); } #[test] fn json_invalid_key() { let example: Result, _> = serde_json::from_str(r#"{"a": 5, "b": 10, "c": 6}"#); assert!(example.is_err()); } #[test] fn bincode_serialization() { let example = enum_map! { false => 3u8, true => 4u8 }; let config = bincode::config::standard(); let serialized = bincode::serde::encode_to_vec(&example, config).unwrap(); assert_eq!( example, bincode::serde::decode_from_slice(&serialized, config) .unwrap() .0 ); } #[test] fn bincode_too_short_deserialization() { let config = bincode::config::standard(); assert!( bincode::serde::decode_from_slice::, _>( &bincode::serde::encode_to_vec(&(), config).unwrap(), config ) .is_err() ); } enum-map/enum-map/tests/test.rs000066400000000000000000000400041510731235700170050ustar00rootroot00000000000000// SPDX-FileCopyrightText: 2018 - 2023 Luna Borowska // SPDX-FileCopyrightText: 2019 Riey // SPDX-FileCopyrightText: 2020 Amanieu d'Antras // SPDX-FileCopyrightText: 2021 Bruno Corrêa Zimmermann // SPDX-FileCopyrightText: 2021 micycle // SPDX-FileCopyrightText: 2022 Cass Fridkin // // SPDX-License-Identifier: MIT OR Apache-2.0 #![warn(clippy::pedantic)] use std::{ cell::{Cell, RefCell}, collections::HashSet, convert::Infallible, marker::PhantomData, num::ParseIntError, panic::{UnwindSafe, catch_unwind}, }; use enum_map::{Enum, EnumMap, IntoIter, enum_map}; #[allow(unused_imports)] use enum_map_derive::*; #[allow( dead_code, reason = "this only exists to verify that the macro doesn't invoke it" )] trait From: Sized { fn from(_: T) -> Self { unreachable!(); } } impl From for U {} #[derive(Copy, Clone, Debug, Enum, PartialEq)] enum Example { A, B, C, } #[test] fn test_bool() { let mut map = enum_map! { false => 24, true => 42 }; assert_eq!(map[false], 24); assert_eq!(map[true], 42); map[false] += 1; assert_eq!(map[false], 25); for (key, item) in &mut map { if !key { *item += 1; } } assert_eq!(map[false], 26); assert_eq!(map[true], 42); } #[test] fn test_clone() { let map = enum_map! { false => 3, true => 5 }; assert_eq!(map.clone(), map); } #[test] fn test_debug() { let map = enum_map! { false => 3, true => 5 }; assert_eq!(format!("{map:?}"), "{false: 3, true: 5}"); } #[test] fn test_hash() { let map = enum_map! { false => 3, true => 5 }; let mut set = HashSet::new(); set.insert(map); assert!(set.contains(&map)); } #[test] fn test_clear() { let mut map = enum_map! { false => 1, true => 2 }; map.clear(); assert_eq!(map[true], 0); assert_eq!(map[false], 0); } #[test] fn struct_of_enum() { #[derive(Copy, Clone, Debug, Enum, PartialEq)] struct Product { example: Example, is_done: bool, } let mut map = enum_map! { Product { example: Example::A, is_done: false } => "foo", Product { example: Example::B, is_done: false } => "bar", Product { example: Example::C, is_done: false } => "baz", Product { example: Example::A, is_done: true } => "done foo", Product { example: Example::B, is_done: true } => "bar done", Product { example: Example::C, is_done: true } => "doooozne", }; assert_eq!( map[Product { example: Example::B, is_done: false }], "bar" ); assert_eq!( map[Product { example: Example::C, is_done: false }], "baz" ); assert_eq!( map[Product { example: Example::B, is_done: true }], "bar done" ); map[Product { example: Example::B, is_done: true, }] = "not really done"; assert_eq!( map[Product { example: Example::B, is_done: false }], "bar" ); assert_eq!( map[Product { example: Example::C, is_done: false }], "baz" ); assert_eq!( map[Product { example: Example::B, is_done: true }], "not really done" ); } #[test] fn tuple_struct_of_enum() { #[derive(Copy, Clone, Debug, Enum, PartialEq)] struct Product(Example, bool); let mut map = enum_map! { Product(Example::A, false) => "foo", Product(Example::B, false) => "bar", Product(Example::C, false) => "baz", Product(Example::A, true) => "done foo", Product(Example::B, true) => "bar done", Product(Example::C, true) => "doooozne", }; assert_eq!(map[Product(Example::B, false)], "bar"); assert_eq!(map[Product(Example::C, false)], "baz"); assert_eq!(map[Product(Example::B, true)], "bar done"); map[Product(Example::B, true)] = "not really done"; assert_eq!(map[Product(Example::B, false)], "bar"); assert_eq!(map[Product(Example::C, false)], "baz"); assert_eq!(map[Product(Example::B, true)], "not really done"); } #[test] fn discriminants() { #[derive(Debug, Enum, PartialEq)] enum Discriminants { A = 2000, B = 3000, C = 1000, } let mut map = EnumMap::default(); map[Discriminants::A] = 3; map[Discriminants::B] = 2; map[Discriminants::C] = 1; let mut pairs = map.iter(); assert_eq!(pairs.next(), Some((Discriminants::A, &3))); assert_eq!(pairs.next(), Some((Discriminants::B, &2))); assert_eq!(pairs.next(), Some((Discriminants::C, &1))); assert_eq!(pairs.next(), None); } #[test] fn extend() { let mut map = enum_map! { _ => 0 }; map.extend(vec![(Example::A, 3)]); map.extend(vec![(&Example::B, &4)]); assert_eq!( map, enum_map! { Example::A => 3, Example::B => 4, Example::C => 0 } ); } #[test] fn collect() { let iter = vec![(Example::A, 5), (Example::B, 7)] .into_iter() .map(|(k, v)| (k, v + 1)); assert_eq!( iter.collect::>(), enum_map! { Example::A => 6, Example::B => 8, Example::C => 0 } ); } #[test] fn huge_enum() { #[derive(Enum)] enum Example { A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Aa, Bb, Cc, Dd, Ee, Ff, Gg, Hh, Ii, Jj, Kk, Ll, Mm, Nn, Oo, Pp, Qq, Rr, Ss, Tt, Uu, Vv, Ww, Xx, Yy, Zz, } let map = enum_map! { _ => 2 }; assert_eq!(map[Example::Xx], 2); } #[test] fn iterator_len() { assert_eq!( enum_map! { Example::A | Example::B | Example::C => 0 } .iter() .len(), 3 ); } #[test] fn iter_mut_len() { assert_eq!( enum_map! { Example::A | Example::B | Example::C => 0 } .iter_mut() .len(), 3 ); } #[test] fn into_iter_len() { assert_eq!(enum_map! { Example::A | _ => 0 }.into_iter().len(), 3); } #[test] fn iterator_next_back() { assert_eq!( enum_map! { Example::A => 1, Example::B => 2, Example::C => 3 } .iter() .next_back(), Some((Example::C, &3)) ); } #[test] fn iter_mut_next_back() { assert_eq!( enum_map! { Example::A => 1, Example::B => 2, Example::C => 3 } .iter_mut() .next_back(), Some((Example::C, &mut 3)) ); } #[test] fn into_iter() { let mut iter = enum_map! { true => 5, false => 7 }.into_iter(); assert_eq!(iter.next(), Some((false, 7))); assert_eq!(iter.next(), Some((true, 5))); assert_eq!(iter.next(), None); assert_eq!(iter.next(), None); } #[test] fn into_iter_u8() { assert_eq!( enum_map! { i => i }.into_iter().collect::>(), (0..=u8::MAX).map(|x| (x, x)).collect::>() ); } struct DropReporter<'a> { into: &'a RefCell>, value: usize, } impl Drop for DropReporter<'_> { fn drop(&mut self) { self.into.borrow_mut().push(self.value); } } #[test] fn into_iter_drop() { let dropped = RefCell::new(Vec::default()); let mut a: IntoIter = enum_map! { k => DropReporter { into: &dropped, value: k as usize, }, } .into_iter(); assert_eq!(a.next().unwrap().0, Example::A); assert_eq!(*dropped.borrow(), &[0]); drop(a); assert_eq!(*dropped.borrow(), &[0, 1, 2]); } #[test] fn into_iter_double_ended_iterator() { let mut iter = enum_map! { 0 => 5, 255 => 7, _ => 0 }.into_iter(); assert_eq!(iter.next(), Some((0, 5))); assert_eq!(iter.next_back(), Some((255, 7))); assert_eq!(iter.next(), Some((1, 0))); assert_eq!(iter.next_back(), Some((254, 0))); assert!(iter.rev().eq((2..254).rev().map(|i| (i, 0)))); } #[test] fn values_rev_collect() { assert_eq!( vec![3, 2, 1], enum_map! { Example::A => 1, Example::B => 2, Example::C => 3 } .values() .rev() .copied() .collect::>() ); } #[test] fn values_len() { assert_eq!(enum_map! { false => 0, true => 1 }.values().len(), 2); } #[test] fn into_values_rev_collect() { assert_eq!( vec![3, 2, 1], enum_map! { Example::A => 1, Example::B => 2, Example::C => 3 } .into_values() .rev() .collect::>() ); } #[test] fn into_values_len() { assert_eq!(enum_map! { false => 0, true => 1 }.into_values().len(), 2); } #[test] fn values_mut_next_back() { let mut map = enum_map! { false => 0, true => 1 }; assert_eq!(map.values_mut().next_back(), Some(&mut 1)); } #[test] fn test_u8() { let mut map = enum_map! { b'a' => 4, _ => 0 }; map[b'c'] = 3; assert_eq!(map[b'a'], 4); assert_eq!(map[b'b'], 0); assert_eq!(map[b'c'], 3); assert_eq!(map.iter().next(), Some((0, &0))); } #[derive(Enum)] enum Void {} #[test] fn empty_map() { let void: EnumMap = enum_map! {}; assert_eq!(void.len(), 0); } #[test] #[should_panic(expected = "unreachable")] fn empty_value() { let _void: EnumMap = enum_map! { _ => unreachable!() }; } #[test] fn empty_infallible_map() { let void: EnumMap = enum_map! {}; assert_eq!(void.len(), 0); } #[derive(Clone, Copy)] enum X { A(PhantomData<*const ()>), } impl Enum for X { type Array = [V; 1]; fn from_usize(arg: usize) -> X { assert_eq!(arg, 0); X::A(PhantomData) } fn into_usize(self) -> usize { 0 } } fn assert_sync_send(_: T) {} #[test] #[allow( clippy::needless_borrows_for_generic_args, reason = "being extra thorough" )] fn assert_enum_map_does_not_copy_sync_send_dependency_of_keys() { let mut map = enum_map! { X::A(PhantomData) => true }; assert_sync_send(map); assert_sync_send(&map); assert_sync_send(&mut map); assert_sync_send(map.iter()); assert_sync_send(map.iter_mut()); assert_sync_send(map.into_iter()); assert!(map[X::A(PhantomData)]); } #[test] fn test_sum() { assert_eq!( enum_map! { i => u8::into(i) } .iter() .map(|(_, v)| v) .sum::(), 32_640 ); } #[test] fn test_sum_mut() { assert_eq!( enum_map! { i => u8::into(i) } .iter_mut() .map(|(_, &mut v)| -> u32 { v }) .sum::(), 32_640 ); } #[test] fn test_iter_clone() { struct S(u8); let map = enum_map! { Example::A => S(3), Example::B => S(4), Example::C => S(1), }; let iter = map.iter(); assert_eq!(iter.clone().map(|(_, S(v))| v).sum::(), 8); assert_eq!(iter.map(|(_, S(v))| v).sum::(), 8); let values = map.values(); assert_eq!(values.clone().map(|S(v)| v).sum::(), 8); assert_eq!(values.map(|S(v)| v).sum::(), 8); } #[test] fn question_mark() -> Result<(), ParseIntError> { let map = enum_map! { false => "2".parse()?, true => "5".parse()? }; assert_eq!(map, enum_map! { false => 2, true => 5 }); Ok(()) } #[test] fn question_mark_failure() { struct IncOnDrop<'a>(&'a Cell); impl Drop for IncOnDrop<'_> { fn drop(&mut self) { self.0.set(self.0.get() + 1); } } fn failible() -> Result, &'static str> { Err("ERROR!") } fn try_block(inc: &Cell) -> Result<(), &'static str> { enum_map! { 32 => failible()?, _ => { IncOnDrop(inc) } }; Ok(()) } let value = Cell::new(0); assert_eq!(try_block(&value), Err("ERROR!")); assert_eq!(value.get(), 32); } #[test] #[should_panic = "Intentional panic"] fn map_panic() { let map: EnumMap = enum_map! { i => i.to_string() }; map.map(|k, v| { assert_ne!(k, 2, "Intentional panic"); v + " modified" }); } macro_rules! make_enum_map_macro_safety_test { ($a:tt $b:tt) => { // This is misuse of an API, however we need to test that to ensure safety // as we use unsafe code. enum E { A, B, C, } impl Enum for E { type Array = [V; $a]; fn from_usize(value: usize) -> E { match value { 0 => E::A, 1 => E::B, 2 => E::C, _ => unimplemented!(), } } fn into_usize(self) -> usize { self as usize } } let map: EnumMap = enum_map! { _ => "Hello, world!".into() }; map.into_iter(); }; } #[test] fn enum_map_macro_safety_under() { make_enum_map_macro_safety_test!(2 3); } #[test] fn enum_map_macro_safety_over() { make_enum_map_macro_safety_test!(3 2); } #[test] fn drop_panic_into_iter() { struct DropHandler<'a>(&'a Cell); impl Drop for DropHandler<'_> { fn drop(&mut self) { self.0.set(self.0.get() + 1); } } impl UnwindSafe for DropHandler<'_> {} struct Storage<'a> { should_panic: bool, _drop_handler: DropHandler<'a>, } impl Drop for Storage<'_> { fn drop(&mut self) { assert!(!self.should_panic); } } let cell = Cell::new(0); let map: EnumMap = enum_map! { v => Storage { should_panic: v == Example::B, _drop_handler: DropHandler(&cell) }, }; assert!( catch_unwind(|| { map.into_iter(); }) .is_err() ); assert_eq!(cell.get(), 3); } #[test] fn test_const_enum_map_from_array() { const CONST_ENUM_MAP_FROM_ARRAY: EnumMap = EnumMap::from_array([4, 8]); assert_eq!( CONST_ENUM_MAP_FROM_ARRAY, enum_map! { false => 4, true => 8 }, ); } #[test] fn usize_override() { #![allow(non_camel_case_types, dead_code)] type usize = (); #[derive(Enum)] #[allow(dead_code)] enum X { A, B, } } #[test] fn nested_types() { #![allow(dead_code)] #[derive(Enum)] enum V { V, } #[derive(Enum)] struct StructureCanHoldV { v: V, } } // Regression test for https://codeberg.org/xfix/enum-map/issues/112 #[test] fn test_issue_112() { #[derive(Enum, PartialEq, Debug)] enum Inner { Inner1, Inner2, } #[derive(Enum, PartialEq, Debug)] enum Outer { A, B(Inner), C, D(Inner, Inner), E, } assert_eq!(Outer::A.into_usize(), 0); assert_eq!(Outer::A, Outer::from_usize(0)); assert_eq!(Outer::B(Inner::Inner1).into_usize(), 1); assert_eq!(Outer::B(Inner::Inner1), Outer::from_usize(1)); assert_eq!(Outer::B(Inner::Inner2).into_usize(), 2); assert_eq!(Outer::B(Inner::Inner2), Outer::from_usize(2)); assert_eq!(Outer::C.into_usize(), 3); assert_eq!(Outer::C, Outer::from_usize(3)); assert_eq!(Outer::D(Inner::Inner1, Inner::Inner1).into_usize(), 4); assert_eq!(Outer::D(Inner::Inner1, Inner::Inner1), Outer::from_usize(4)); assert_eq!(Outer::D(Inner::Inner2, Inner::Inner1).into_usize(), 5); assert_eq!(Outer::D(Inner::Inner2, Inner::Inner1), Outer::from_usize(5)); assert_eq!(Outer::D(Inner::Inner1, Inner::Inner2).into_usize(), 6); assert_eq!(Outer::D(Inner::Inner1, Inner::Inner2), Outer::from_usize(6)); assert_eq!(Outer::D(Inner::Inner2, Inner::Inner2).into_usize(), 7); assert_eq!(Outer::D(Inner::Inner2, Inner::Inner2), Outer::from_usize(7)); assert_eq!(Outer::E.into_usize(), 8); assert_eq!(Outer::E, Outer::from_usize(8)); } enum-map/renovate.json000066400000000000000000000007721510731235700153250ustar00rootroot00000000000000{ "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": ["config:recommended", ":preserveSemverRanges"], "packageRules": [ { "matchPackageNames": ["instrumentisto/rust"], "extends": ["schedule:monthly"], "versioning": "regex:^nightly-(?\\d+)-(?\\d+)-(?\\d+)$" }, { "matchPackageNames": ["rust"], "matchCurrentVersion": "/^1\\.85\\./", "matchUpdateTypes": ["major", "minor"], "enabled": false } ] } enum-map/renovate.json.license000066400000000000000000000001521510731235700167360ustar00rootroot00000000000000SPDX-FileCopyrightText: 2023 Luna Borowska SPDX-License-Identifier: MIT OR Apache-2.0