RGBCube/embd-rs
1
Fork 0
mirror of https://github.com/RGBCube/embd-rs synced 2025-07-27 05:27:44 +00:00
Code Issues Activity Actions

Rename to embd

Browse source
This commit is contained in:
RGBCube 2024-02-22 10:50:17 +03:00
parent 7c2eb614db
commit 53f550c9c0
No known key found for this signature in database
10 changed files with 86 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,7 +1,7 @@
# embed-rs
# embd-rs
A super simple file and directory embedding crate,
that loads files from the filesystem in debug mode,
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
@ -16,24 +16,27 @@ Add this to your Cargo.toml:
```toml
[dependencies]
embed = { git = "https://github.com/RGBCube/embed-rs" }
[patch.crates-io]
proc-macro2 = { git = "https://github.com/RGBCube/proc-macro2" }
embd = "0.1"
```
Then you can use this crate as so:
Then you can use this crate like so:
```rs
let contents: Cow<'_, str> = embed::string!("path/to/file.txt");
let bytes: Cow<'_, [u8]> = embed::bytes!("path/to/image.png");
let contents: Cow<'_, str> = embd::string!("path/to/file.txt");
let bytes: Cow<'_, [u8]> = embd::bytes!("path/to/image.png");
let dir: embed::Dir = embed::dir!("path/to");
let files: Vec<embed::File> = dir.flatten();
let dir: embd::Dir = embd::dir!("path/to");
let files: Vec<embd::File> = dir.flatten();
```
I am not sure what name to publish this
crate in, lmk if you find a good one.
Note that you will need to enable the `procmacro2_semver_exempt` feature
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" ]
```
## License