├── .gitignore ├── Cargo.toml ├── LICENSE-MIT ├── .github └── workflows │ └── main.yml ├── readme.md ├── src └── lib.rs └── LICENSE-APACHE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "literally" 3 | version = "0.1.3" 4 | license = "MIT/Apache-2.0" 5 | repository = "https://github.com/estk/literally" 6 | authors = ["Evan Simmons "] 7 | description = "Macro literals for members of std::collections" 8 | edition = "2018" 9 | 10 | [dependencies] 11 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | lint: 13 | name: Lint 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout the source code 17 | uses: actions/checkout@master 18 | 19 | - name: Install Rust stable 20 | run: | 21 | rustup toolchain update --no-self-update stable 22 | rustup default stable 23 | rustup component add clippy rustfmt 24 | - name: Run rustfmt 25 | run: cargo fmt -- --check 26 | 27 | - name: Run clippy 28 | run: cargo clippy --all-features 29 | env: 30 | RUSTFLAGS: -D warnings 31 | 32 | 33 | test: 34 | name: Test 35 | runs-on: ${{ matrix.os }} 36 | strategy: 37 | matrix: 38 | rust_versions: ["stable", "1.38.0"] 39 | os: [ubuntu-latest, windows-latest] 40 | steps: 41 | - name: Checkout the source code 42 | uses: actions/checkout@master 43 | 44 | - name: Install Rust Versions 45 | run: | 46 | rustup toolchain install --no-self-update ${{ matrix.rust_versions }} 47 | rustup default stable 48 | - name: Build lib 49 | run: rustup run ${{ matrix.rust_versions }} cargo build ${{ matrix.cargo_build_flags }} 50 | 51 | - name: test lib 52 | run: cargo test --all-features 53 | env: 54 | RUSTFLAGS: -D warnings 55 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Literally 2 | 3 | [![docs](https://docs.rs/literally/badge.svg)](https://docs.rs/literally) 4 | [![crates.io](https://img.shields.io/crates/v/literally.svg)](https://crates.io/crates/literally) 5 | [![License: MIT OR Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license) 6 | ![CI](https://github.com/estk/literally/workflows/CI/badge.svg) 7 | [![Minimum rustc version](https://img.shields.io/badge/rustc-1.38+-green.svg)](https://github.com/estk/literally#rust-version-requirements) 8 | 9 | I found the methods and ergonomics of [`maplit`](#credit) aggravating so I made this. It's basically the same code except that the names are different and the values are `.into()`'d. 10 | 11 | Enjoy. 12 | 13 | ## Example 14 | 15 | ```rust 16 | use std::collections::{HashMap, HashSet}; 17 | use literally::{hmap, hset}; 18 | let m: HashMap> = hmap!{ 19 | "key" => hset!{ 20 | "value" 21 | } 22 | }; 23 | assert_eq!(m.get("key").unwrap().get("value"), Some(&"value".to_string())) 24 | ``` 25 | 26 | 27 | ## Rust Version Requirements 28 | 29 | 1.38+ 30 | 31 | ## License 32 | 33 | Licensed under either of the following at your option. 34 | 35 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 36 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 37 | 38 | ### Credit 39 | 40 | Like I said, this *is* `maplit` but with ergonomics changes. All credit should be directed there. Again, I literally copied and pasted the code from `maplit` and changed the ergonomics slightly. 41 | 42 | ## Contribution 43 | 44 | Unless you explicitly state otherwise, any contribution intentionally submitted 45 | for inclusion in the work by you shall be dual licensed as above, without any 46 | additional terms or conditions. 47 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! When you literally just want a literal of the `std::collections` types. 2 | //! 3 | //! ```rust 4 | //! # use std::collections::{HashMap, HashSet}; 5 | //! # use literally::{hmap, hset}; 6 | //! let m: HashMap> = hmap!{ 7 | //! "key" => hset!{ 8 | //! "value" 9 | //! } 10 | //! }; 11 | //! assert_eq!(m.get("key").unwrap().get("value"), Some(&"value".to_string())) 12 | //! ``` 13 | 14 | /// Literally just a HashMap literal with keys and values into'd. 15 | /// ```rust 16 | /// # use std::collections::HashMap; 17 | /// # use literally::hmap; 18 | /// let m: HashMap = hmap!{ "key" => "value" }; 19 | /// assert_eq!(m.get("key"), Some(&"value".to_string())) 20 | /// ``` 21 | /// 22 | #[macro_export(local_inner_macros)] 23 | macro_rules! hmap { 24 | (@single $($x:tt)*) => (()); 25 | (@count $($rest:expr),*) => (<[()]>::len(&[$(hmap!(@single $rest)),*])); 26 | 27 | ($($key:expr => $value:expr),* $(,)?) => { 28 | { 29 | let _cap = hmap!(@count $($key),*); 30 | let mut _map = ::std::collections::HashMap::with_capacity(_cap); 31 | $( 32 | let _ = _map.insert($key.into(), $value.into()); 33 | )* 34 | _map 35 | } 36 | }; 37 | } 38 | 39 | /// Literally just a HashSet literal with values into'd. 40 | /// ```rust 41 | /// # use std::collections::HashSet; 42 | /// # use literally::hset; 43 | /// let s: HashSet = hset!{ "value" }; 44 | /// assert_eq!(s.get("value"), Some(&"value".to_string())) 45 | /// ``` 46 | /// 47 | #[macro_export(local_inner_macros)] 48 | macro_rules! hset { 49 | (@single $($x:tt)*) => (()); 50 | (@count $($rest:expr),*) => (<[()]>::len(&[$(hset!(@single $rest)),*])); 51 | 52 | ($($key:expr,)+) => { hset!($($key),+) }; 53 | ($($key:expr),*) => { 54 | { 55 | let _cap = hset!(@count $($key),*); 56 | let mut _set = ::std::collections::HashSet::with_capacity(_cap); 57 | $( 58 | let _ = _set.insert($key.into()); 59 | )* 60 | _set 61 | } 62 | }; 63 | } 64 | 65 | /// Literally just a BTreeMap literal with keys and values into'd. 66 | /// ```rust 67 | /// # use std::collections::BTreeMap; 68 | /// # use literally::bmap; 69 | /// let m: BTreeMap = bmap!{ "key" => "value" }; 70 | /// assert_eq!(m.get("key"), Some(&"value".to_string())) 71 | /// ``` 72 | /// 73 | #[macro_export(local_inner_macros)] 74 | macro_rules! bmap { 75 | ( $($key:expr => $value:expr),* $(,)?) => { 76 | { 77 | let mut _map = ::std::collections::BTreeMap::new(); 78 | $( 79 | let _ = _map.insert($key.into(), $value.into()); 80 | )* 81 | _map 82 | } 83 | }; 84 | } 85 | 86 | /// Literally just a BTreeSet literal with values into'd. 87 | /// ```rust 88 | /// # use std::collections::BTreeSet; 89 | /// # use literally::bset; 90 | /// let s: BTreeSet = bset!{ "value" }; 91 | /// assert_eq!(s.get("value"), Some(&"value".to_string())) 92 | /// ``` 93 | /// 94 | #[macro_export(local_inner_macros)] 95 | macro_rules! bset { 96 | ( $($key:expr),* $(,)? ) => { 97 | { 98 | let mut _set = ::std::collections::BTreeSet::new(); 99 | $( 100 | _set.insert($key.into()); 101 | )* 102 | _set 103 | } 104 | }; 105 | } 106 | 107 | /// Literally just a VecDeque literal with values into'd. 108 | /// ```rust 109 | /// # use std::collections::VecDeque; 110 | /// # use literally::vecd; 111 | /// let s: VecDeque = vecd![ "value" ]; 112 | /// assert_eq!(s.get(0), Some(&"value".to_string())) 113 | /// ``` 114 | /// 115 | #[macro_export(local_inner_macros)] 116 | macro_rules! vecd { 117 | ( $($key:expr),* $(,)? ) => { 118 | ::std::collections::VecDeque::from(::std::vec![$( 119 | $key.into() 120 | ),*]) 121 | } 122 | } 123 | 124 | /// Literally just a LinkedList literal with values into'd. 125 | /// ```rust 126 | /// # use std::collections::LinkedList; 127 | /// # use literally::list; 128 | /// let l: LinkedList = list![ "value" ]; 129 | /// assert_eq!(l.front(), Some(&"value".to_string())) 130 | /// ``` 131 | /// 132 | #[macro_export(local_inner_macros)] 133 | macro_rules! list { 134 | ( $($key:expr),* $(,)? ) => { 135 | { 136 | let mut _lst = ::std::collections::LinkedList::new(); 137 | $( 138 | _lst.push_back($key.into()); 139 | )* 140 | _lst 141 | } 142 | }; 143 | } 144 | 145 | /// Literally just a BinaryHeap literal with values into'd. 146 | /// ```rust 147 | /// # use std::collections::BinaryHeap; 148 | /// # use literally::heap; 149 | /// let l: BinaryHeap = heap![ "value" ]; 150 | /// assert_eq!(l.peek(), Some(&"value".to_string())) 151 | /// ``` 152 | /// 153 | #[macro_export(local_inner_macros)] 154 | macro_rules! heap { 155 | ( $($key:expr),* $(,)? ) => { 156 | { 157 | let mut _heap = ::std::collections::BinaryHeap::new(); 158 | $( 159 | _heap.push($key.into()); 160 | )* 161 | _heap 162 | } 163 | }; 164 | } 165 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------