mirror of
https://github.com/RGBCube/embd-rs
synced 2025-07-27 05:27:44 +00:00
Remove procmacro2_semver_exempt
This commit is contained in:
parent
a4724700b2
commit
8dd31ecc77
9 changed files with 2 additions and 188 deletions
|
@ -1,2 +0,0 @@
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,7 +1,5 @@
|
||||||
*
|
*
|
||||||
|
|
||||||
!.cargo/
|
|
||||||
|
|
||||||
!embd/
|
!embd/
|
||||||
!embd/src/
|
!embd/src/
|
||||||
|
|
||||||
|
|
10
README.md
10
README.md
|
@ -29,19 +29,9 @@ let dir: embd::Dir = embd::dir!("path/to");
|
||||||
let files: Vec<embd::File> = dir.flatten();
|
let files: Vec<embd::File> = dir.flatten();
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that you will need to enable the `procmacro2_semver_exempt` cfg
|
|
||||||
option to use this crate, you can enable it like so, by putting this in
|
|
||||||
`.cargo/config.toml` in the project root:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
## To-Do
|
## To-Do
|
||||||
|
|
||||||
- [ ] Hot reloading of files in debug mode.
|
- [ ] Hot reloading of files in debug mode.
|
||||||
- [ ] Don't depend on `procmacro2_semver_exempt`.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -8,10 +8,7 @@ categories = [ "filesystem" ]
|
||||||
authors = [ "RGBCube" ]
|
authors = [ "RGBCube" ]
|
||||||
version = "0.1.4"
|
version = "0.1.4"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
include = [ "src/**/*.rs", "README.md" ]
|
include = [ "src/**/*.rs", "../README.md" ]
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
rustc-args = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
proc-macro = true
|
proc-macro = true
|
||||||
|
|
|
@ -1,68 +0,0 @@
|
||||||
# embd-rs
|
|
||||||
|
|
||||||
A super simple file and directory embedding crate,
|
|
||||||
that loads files from the filesystem on debug mode,
|
|
||||||
allowing for quick edit-and-test cycles without compilation.
|
|
||||||
|
|
||||||
It is also super efficient, and does not heap allocate when the
|
|
||||||
files are embedded on release mode by utilizing `std::borrow::Cow`.
|
|
||||||
|
|
||||||
On release mode it falls back to `include_str!`, `include_bytes!`
|
|
||||||
and our own custom `include_dir!`-like implementation.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Add this to your Cargo.toml:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
embd = "0.1"
|
|
||||||
```
|
|
||||||
|
|
||||||
Then you can use this crate like so:
|
|
||||||
|
|
||||||
```rs
|
|
||||||
let contents: Cow<'_, str> = embd::string!("path/to/file.txt");
|
|
||||||
let bytes: Cow<'_, [u8]> = embd::bytes!("path/to/image.png");
|
|
||||||
|
|
||||||
let dir: embd::Dir = embd::dir!("path/to");
|
|
||||||
let files: Vec<embd::File> = dir.flatten();
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that you will need to enable the `procmacro2_semver_exempt` cfg
|
|
||||||
option to use this crate, you can enable it like so, by putting this in
|
|
||||||
`.cargo/config.toml` in the project root:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
## To-Do
|
|
||||||
|
|
||||||
- [ ] Hot reloading of files in debug mode.
|
|
||||||
- [ ] Don't depend on `procmacro2_semver_exempt`.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
```
|
|
||||||
Copyright (c) 2023-present RGBCube
|
|
||||||
|
|
||||||
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.
|
|
||||||
```
|
|
|
@ -1,28 +1,15 @@
|
||||||
#![allow(unexpected_cfgs)]
|
#![allow(unexpected_cfgs)]
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
use std::{
|
use std::{
|
||||||
fs,
|
fs,
|
||||||
path::Path,
|
path::Path,
|
||||||
};
|
};
|
||||||
|
|
||||||
#[cfg(not(procmacro2_semver_exempt))]
|
|
||||||
compile_error!(
|
|
||||||
r#"pass `--cfg procmacro2_semver_exempt` to rustc to compile embd-macros or add this to your `.cargo/config.toml`:
|
|
||||||
|
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
|
|
||||||
"#
|
|
||||||
);
|
|
||||||
|
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
use proc_macro as pm1;
|
use proc_macro as pm1;
|
||||||
use proc_macro2::TokenStream;
|
use proc_macro2::TokenStream;
|
||||||
use quote::{
|
use quote::{
|
||||||
quote,
|
quote,
|
||||||
ToTokens,
|
ToTokens,
|
||||||
};
|
};
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
use syn::{
|
use syn::{
|
||||||
parse_macro_input,
|
parse_macro_input,
|
||||||
spanned::Spanned,
|
spanned::Spanned,
|
||||||
|
@ -42,7 +29,6 @@ impl ToTokens for TokenVec {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[proc_macro]
|
#[proc_macro]
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
pub fn __dir(input: pm1::TokenStream) -> pm1::TokenStream {
|
pub fn __dir(input: pm1::TokenStream) -> pm1::TokenStream {
|
||||||
let input2 = input.clone();
|
let input2 = input.clone();
|
||||||
let path = parse_macro_input!(input2 as LitStr).value();
|
let path = parse_macro_input!(input2 as LitStr).value();
|
||||||
|
@ -65,14 +51,12 @@ pub fn __dir(input: pm1::TokenStream) -> pm1::TokenStream {
|
||||||
.into()
|
.into()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
fn dir_debug(path: &str) -> TokenStream {
|
fn dir_debug(path: &str) -> TokenStream {
|
||||||
quote! {
|
quote! {
|
||||||
::embd::__dir_runtime(file!(), #path)
|
::embd::__dir_runtime(file!(), #path)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
fn dir_release(input: TokenStream, path: &str) -> TokenStream {
|
fn dir_release(input: TokenStream, path: &str) -> TokenStream {
|
||||||
let neighbor = TokenStream::from(input).span().source_file().path();
|
let neighbor = TokenStream::from(input).span().source_file().path();
|
||||||
|
|
||||||
|
@ -95,7 +79,6 @@ fn dir_release(input: TokenStream, path: &str) -> TokenStream {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
fn read_dir(directory: &Path) -> TokenVec {
|
fn read_dir(directory: &Path) -> TokenVec {
|
||||||
let mut entries = Vec::new();
|
let mut entries = Vec::new();
|
||||||
|
|
||||||
|
|
|
@ -8,10 +8,7 @@ categories = [ "filesystem" ]
|
||||||
authors = [ "RGBCube" ]
|
authors = [ "RGBCube" ]
|
||||||
version = "0.1.4"
|
version = "0.1.4"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
include = [ "src/**/*.rs", "README.md" ]
|
include = [ "src/**/*.rs", "../README.md" ]
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
|
||||||
rustc-args = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
embd-macros = "0.1"
|
embd-macros = "0.1"
|
||||||
|
|
|
@ -1,68 +0,0 @@
|
||||||
# embd-rs
|
|
||||||
|
|
||||||
A super simple file and directory embedding crate,
|
|
||||||
that loads files from the filesystem on debug mode,
|
|
||||||
allowing for quick edit-and-test cycles without compilation.
|
|
||||||
|
|
||||||
It is also super efficient, and does not heap allocate when the
|
|
||||||
files are embedded on release mode by utilizing `std::borrow::Cow`.
|
|
||||||
|
|
||||||
On release mode it falls back to `include_str!`, `include_bytes!`
|
|
||||||
and our own custom `include_dir!`-like implementation.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Add this to your Cargo.toml:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[dependencies]
|
|
||||||
embd = "0.1"
|
|
||||||
```
|
|
||||||
|
|
||||||
Then you can use this crate like so:
|
|
||||||
|
|
||||||
```rs
|
|
||||||
let contents: Cow<'_, str> = embd::string!("path/to/file.txt");
|
|
||||||
let bytes: Cow<'_, [u8]> = embd::bytes!("path/to/image.png");
|
|
||||||
|
|
||||||
let dir: embd::Dir = embd::dir!("path/to");
|
|
||||||
let files: Vec<embd::File> = dir.flatten();
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that you will need to enable the `procmacro2_semver_exempt` cfg
|
|
||||||
option to use this crate, you can enable it like so, by putting this in
|
|
||||||
`.cargo/config.toml` in the project root:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
## To-Do
|
|
||||||
|
|
||||||
- [ ] Hot reloading of files in debug mode.
|
|
||||||
- [ ] Don't depend on `procmacro2_semver_exempt`.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
```
|
|
||||||
Copyright (c) 2023-present RGBCube
|
|
||||||
|
|
||||||
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.
|
|
||||||
```
|
|
|
@ -5,16 +5,6 @@ use std::{
|
||||||
path::Path,
|
path::Path,
|
||||||
};
|
};
|
||||||
|
|
||||||
#[cfg(not(procmacro2_semver_exempt))]
|
|
||||||
compile_error!(
|
|
||||||
r#"pass `--cfg procmacro2_semver_exempt` to rustc to compile embd or add this to your `.cargo/config.toml`:
|
|
||||||
|
|
||||||
[build]
|
|
||||||
rustflags = [ "--cfg", "procmacro2_semver_exempt" ]
|
|
||||||
|
|
||||||
"#
|
|
||||||
);
|
|
||||||
|
|
||||||
#[doc(hidden)]
|
#[doc(hidden)]
|
||||||
pub fn __string_runtime(neighbor: &str, path: &str) -> String {
|
pub fn __string_runtime(neighbor: &str, path: &str) -> String {
|
||||||
let file = Path::new(neighbor)
|
let file = Path::new(neighbor)
|
||||||
|
@ -34,7 +24,6 @@ pub fn __string_runtime(neighbor: &str, path: &str) -> String {
|
||||||
/// let content: Cow<'static, str> = embd::string!("main.rs");
|
/// let content: Cow<'static, str> = embd::string!("main.rs");
|
||||||
/// ```
|
/// ```
|
||||||
#[macro_export]
|
#[macro_export]
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
macro_rules! string {
|
macro_rules! string {
|
||||||
($path:literal) => {{
|
($path:literal) => {{
|
||||||
#[cfg(debug_assertions)]
|
#[cfg(debug_assertions)]
|
||||||
|
@ -70,7 +59,6 @@ pub fn __bytes_runtime(neighbor: &str, path: &str) -> Vec<u8> {
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
#[macro_export]
|
#[macro_export]
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
macro_rules! bytes {
|
macro_rules! bytes {
|
||||||
($path:literal) => {{
|
($path:literal) => {{
|
||||||
#[cfg(debug_assertions)]
|
#[cfg(debug_assertions)]
|
||||||
|
@ -232,5 +220,4 @@ pub fn __dir_runtime(neighbor: &str, path: &str) -> Dir {
|
||||||
/// let content: embd::Dir = embd::dir!("../assets");
|
/// let content: embd::Dir = embd::dir!("../assets");
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
#[cfg(procmacro2_semver_exempt)]
|
|
||||||
pub use embd_macros::__dir as dir;
|
pub use embd_macros::__dir as dir;
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue