├── include-bytes-zstd ├── test-resources │ └── input.txt ├── Cargo.toml ├── README.md └── src │ └── lib.rs ├── Cargo.toml ├── include-bytes-zstd-macro ├── README.md ├── Cargo.toml └── src │ └── lib.rs ├── CONTRIBUTING.md ├── LICENSE-MIT ├── .github └── workflows │ └── rust.yml ├── README.md └── LICENSE-APACHE /include-bytes-zstd/test-resources/input.txt: -------------------------------------------------------------------------------- 1 | This is a test. 2 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [workspace] 2 | members = [ 3 | "include-bytes-zstd", 4 | "include-bytes-zstd-macro", 5 | ] 6 | -------------------------------------------------------------------------------- /include-bytes-zstd-macro/README.md: -------------------------------------------------------------------------------- 1 | # `include_bytes_zstd!()` 2 | 3 | This library provides a macro to include a file with zstd compression. 4 | 5 | See the [include-bytes-zstd crate](../README.md) for more details. 6 | 7 | ## License 8 | 9 | Licensed under either of 10 | 11 | * Apache License, Version 2.0 12 | ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 13 | * MIT license 14 | ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT) 15 | 16 | at your option. 17 | 18 | ## Contribution 19 | 20 | See [the guidelines](../CONTRIBUTING.md). 21 | -------------------------------------------------------------------------------- /include-bytes-zstd/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "include-bytes-zstd" 3 | version = "0.1.0" 4 | edition = "2021" 5 | rust-version = "1.64" 6 | authors = ["Koichi Akabe "] 7 | description = "Includes a file with zstd compression" 8 | license = "MIT OR Apache-2.0" 9 | homepage = "https://github.com/daac-tools/include-bytes-zstd" 10 | repository = "https://github.com/daac-tools/include-bytes-zstd" 11 | readme = "README.md" 12 | keywords = ["compression", "zstandard", "zstd"] 13 | categories = ["compression"] 14 | 15 | [dependencies] 16 | include-bytes-zstd-macro = { path = "../include-bytes-zstd-macro", version = "0.1.0" } 17 | ruzstd = "0.3.0" # MIT 18 | -------------------------------------------------------------------------------- /include-bytes-zstd-macro/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "include-bytes-zstd-macro" 3 | version = "0.1.0" 4 | edition = "2021" 5 | rust-version = "1.64" 6 | authors = ["Koichi Akabe "] 7 | description = "Includes a file with zstd compression (proc_macro)" 8 | license = "MIT OR Apache-2.0" 9 | homepage = "https://github.com/daac-tools/include-bytes-zstd" 10 | repository = "https://github.com/daac-tools/include-bytes-zstd" 11 | readme = "README.md" 12 | keywords = ["compression", "zstandard", "zstd"] 13 | categories = ["compression"] 14 | 15 | [lib] 16 | proc_macro = true 17 | 18 | [dependencies] 19 | syn = "1.0" # MIT or Apache-2.0 20 | zstd = "0.12.3" # MIT 21 | proc-macro-crate = "1.3" # MIT or Apache-2.0 22 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | We'd love to accept your patches and contributions to this project. 4 | There are just a few small guidelines you need to follow. 5 | 6 | - Unless you explicitly state otherwise, any contribution intentionally 7 | submitted for inclusion in work by you shall be dual licensed under MIT 8 | license or Apache-2.0 license without any additional terms or conditions. 9 | - All submissions, including submissions by project members, require review. 10 | We use GitHub pull requests for this purpose. 11 | Consult GitHub Help for more information on using pull requests. 12 | 13 | We require all contributors to follow the [daac-tools Code of 14 | Conduct](https://github.com/daac-tools/guidelines/blob/main/conduct.md). 15 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /include-bytes-zstd/README.md: -------------------------------------------------------------------------------- 1 | # `include_bytes_zstd!()` 2 | 3 | This library provides a macro to include a file with zstd compression. 4 | 5 | This macro can be used like `std::include_bytes!`, but the byte array is compressed by the [zstd 6 | crate](https://docs.rs/zstd/). The included data will be decompressed by the [ruzstd 7 | crate](https://docs.rs/ruzstd/) in runtime and returned as a `Vec`. 8 | 9 | This macro performs the decompression each time it is called. 10 | 11 | ## Examples 12 | 13 | `input.txt`: 14 | 15 | ```plain 16 | This is a test. 17 | ``` 18 | 19 | Rust code: 20 | 21 | ```rust 22 | let data = include_bytes_zstd::include_bytes_zstd!("test-resources/input.txt", 19); 23 | assert_eq!(b"This is a test.\n", data.as_slice()); 24 | ``` 25 | 26 | ## License 27 | 28 | Licensed under either of 29 | 30 | * Apache License, Version 2.0 31 | ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 32 | * MIT license 33 | ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT) 34 | 35 | at your option. 36 | 37 | ## Contribution 38 | 39 | See [the guidelines](../CONTRIBUTING.md). 40 | -------------------------------------------------------------------------------- /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | on: 2 | schedule: 3 | - cron: '0 0 * * *' 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | name: build 10 | 11 | env: 12 | CARGO_UNSTABLE_SPARSE_REGISTRY: true 13 | 14 | jobs: 15 | build: 16 | name: Check on ${{ matrix.rust }} 17 | runs-on: ubuntu-latest 18 | strategy: 19 | matrix: 20 | rust: 21 | - 1.64.0 # MSRV 22 | - stable 23 | - nightly 24 | steps: 25 | - uses: actions/checkout@v3 26 | - name: Install ${{ matrix.rust }} 27 | run: | 28 | rustup toolchain install ${{ matrix.rust }} --profile minimal --component rustfmt,clippy 29 | rustup default ${{ matrix.rust }} 30 | 31 | - name: Run cargo check 32 | run: cargo check 33 | 34 | - name: Run cargo fmt 35 | run: cargo fmt --all -- --check 36 | 37 | - name: Run cargo clippy 38 | continue-on-error: ${{ matrix.rust == 'nightly' }} 39 | run: cargo clippy -- -D warnings -W clippy::nursery -W clippy::cast_lossless -W clippy::cast_possible_truncation -W clippy::cast_possible_wrap -A clippy::empty_line_after_outer_attr 40 | 41 | - name: Run cargo test (vaporetto / no-default-features) 42 | run: cargo test --release -p include-bytes-zstd 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `include_bytes_zstd!()` 2 | 3 | This library provides a macro to include a file with zstd compression. 4 | 5 | [![Crates.io](https://img.shields.io/crates/v/include-bytes-zstd)](https://crates.io/crates/include-bytes-zstd) 6 | [![Documentation](https://docs.rs/include-bytes-zstd/badge.svg)](https://docs.rs/include-bytes-zstd) 7 | ![Build Status](https://github.com/daac-tools/include-bytes-zstd/actions/workflows/rust.yml/badge.svg) 8 | 9 | This macro can be used like `std::include_bytes!`, but the byte array is compressed by the [zstd 10 | crate](https://docs.rs/zstd/). The included data will be decompressed by the [ruzstd 11 | crate](https://docs.rs/ruzstd/) in runtime and returned as a `Vec`. 12 | 13 | This macro performs the decompression each time it is called. 14 | 15 | ## Examples 16 | 17 | `input.txt`: 18 | 19 | ```plain 20 | This is a test. 21 | ``` 22 | 23 | Rust code: 24 | 25 | ```rust 26 | let data = include_bytes_zstd::include_bytes_zstd!("test-resources/input.txt", 19); 27 | assert_eq!(b"This is a test.\n", data.as_slice()); 28 | ``` 29 | 30 | ## License 31 | 32 | Licensed under either of 33 | 34 | * Apache License, Version 2.0 35 | ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 36 | * MIT license 37 | ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 38 | 39 | at your option. 40 | 41 | ## Contribution 42 | 43 | See [the guidelines](CONTRIBUTING.md). 44 | -------------------------------------------------------------------------------- /include-bytes-zstd/src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Includes a file with zstd compression. 2 | //! 3 | //! This macro can be used like [`std::include_bytes`], but the byte array is compressed by the 4 | //! [zstd crate](https://docs.rs/zstd/). The included data will be decompressed by the 5 | //! [ruzstd](https://docs.rs/ruzstd) crate in runtime and returned as a [`Vec`]. 6 | //! 7 | //! This macro performs the decompression each time it is called. 8 | //! 9 | //! # Examples 10 | //! 11 | //! `input.txt`: 12 | //! ```plain 13 | //! This is a test. 14 | //! ``` 15 | //! 16 | //! Rust code: 17 | //! ``` 18 | //! let data = include_bytes_zstd::include_bytes_zstd!("test-resources/input.txt", 19); 19 | //! assert_eq!(b"This is a test.\n", data.as_slice()); 20 | //! ``` 21 | 22 | use std::io::Read; 23 | 24 | #[doc(hidden)] 25 | pub use include_bytes_zstd_macro; 26 | 27 | /// Includes a file with zstd compression. 28 | /// 29 | /// # Arguments 30 | /// 31 | /// * `filename` - File name relative to the project root. 32 | /// * `level`: Compression level (1-21). 33 | #[macro_export] 34 | macro_rules! include_bytes_zstd { 35 | ($filename:literal, $level:literal) => {{ 36 | const _: &'static [u8] = 37 | include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/", $filename)); 38 | $crate::include_bytes_zstd_macro::include_bytes_zstd!($filename, $level) 39 | }}; 40 | } 41 | 42 | /// Decodes zstd compressed data. 43 | #[doc(hidden)] 44 | pub fn decode(data: &[u8]) -> Vec { 45 | let mut decoder = ruzstd::StreamingDecoder::new(data).unwrap(); 46 | let mut buff = vec![]; 47 | decoder.read_to_end(&mut buff).unwrap(); 48 | buff 49 | } 50 | -------------------------------------------------------------------------------- /include-bytes-zstd-macro/src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Macro definition of the include-bytes-zstd crate. 2 | 3 | extern crate proc_macro; 4 | 5 | use std::io::Write; 6 | use std::path::PathBuf; 7 | 8 | use proc_macro::TokenStream; 9 | use proc_macro_crate::FoundCrate; 10 | use syn::{parse::Parse, parse_macro_input, LitInt, LitStr, Token}; 11 | 12 | struct Arguments { 13 | filename: LitStr, 14 | _comma: Token![,], 15 | level: LitInt, 16 | } 17 | 18 | impl Parse for Arguments { 19 | fn parse(input: syn::parse::ParseStream) -> syn::Result { 20 | Ok(Self { 21 | filename: input.parse()?, 22 | _comma: input.parse()?, 23 | level: input.parse()?, 24 | }) 25 | } 26 | } 27 | 28 | #[doc(hidden)] 29 | #[proc_macro] 30 | pub fn include_bytes_zstd(input: TokenStream) -> TokenStream { 31 | // parses arguments 32 | let args = parse_macro_input!(input as Arguments); 33 | let filename = PathBuf::from(args.filename.value()); 34 | let level = args.level.base10_parse::().unwrap(); 35 | 36 | // resolves file path 37 | let manifest_dir = PathBuf::from(std::env::var("CARGO_MANIFEST_DIR").unwrap()); 38 | let filename = if filename.is_relative() { 39 | manifest_dir.join(filename) 40 | } else { 41 | filename 42 | }; 43 | 44 | // compression 45 | let bytes = std::fs::read(filename).unwrap(); 46 | let mut compressed = vec![]; 47 | let mut encoder = zstd::Encoder::new(&mut compressed, level).unwrap(); 48 | encoder.write_all(&bytes).unwrap(); 49 | encoder.finish().unwrap(); 50 | 51 | // generates code 52 | let crate_name = proc_macro_crate::crate_name("include-bytes-zstd").unwrap(); 53 | let crate_name = match crate_name { 54 | FoundCrate::Itself => "include_bytes_zstd".to_string(), 55 | FoundCrate::Name(crate_name) => crate_name, 56 | }; 57 | format!("{{ {crate_name}::decode(&{:?}) }}", compressed.as_slice()) 58 | .parse() 59 | .unwrap() 60 | } 61 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------