RGBCube/embd-rs
1
Fork 0
mirror of https://github.com/RGBCube/embd-rs synced 2025-07-25 20:47:45 +00:00
Code Issues Activity Actions

Improve docs and add DirEntry::path

Browse source
This commit is contained in:
RGBCube 2024-01-05 10:01:56 +03:00
parent ccd617123a
commit 8f3c415308
No known key found for this signature in database
1 changed files with 17 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

24
embed/src/lib.rs
View file

@ -14,14 +14,14 @@ pub fn __string_runtime(neighbor: &str, path: &str) -> String {
fs::read_to_string(file).expect("Failed to read file")
}
/// Embed a files contents as a &str on release,
/// read from the filesystem as a String on debug.
/// Embed a files contents as a `&str` on release,
/// read from the filesystem as a `String` on debug.
///
/// # Example
///
/// ```
/// fn main() {
/// let content = embed::string!("main.rs");
/// let content: Cow<'static, str> = embed::string!("main.rs");
/// }
/// ```
#[macro_export]
@ -48,15 +48,15 @@ pub fn __bytes_runtime(neighbor: &str, path: &str) -> Vec<u8> {
fs::read(file).expect("Failed to read file")
}
/// Embed a files contents as a &[u8] on release,
/// read from the filesystem as a Vec<u8> on debug.
/// Embed a files contents as a `&[u8]` on release,
/// read from the filesystem as a `Vec<u8>` on debug.
///
/// # Example
///
/// ```
/// fn main() {
/// // `assets/` is in the same directory as `src/`
/// let content = embed::string!("../assets/icon.png");
/// let content: Cow<'static, [u8]> = embed::string!("../assets/icon.png");
/// }
/// ```
#[macro_export]
@ -82,6 +82,16 @@ pub enum DirEntry {
File(File),
}
impl DirEntry {
/// Returns the absolute path of the entry.
pub fn path(&self) -> &Path {
match self {
DirEntry::File(file) => file.path(),
DirEntry::Dir(dir) => dir.path(),
}
}
}
/// A directory.
#[derive(Debug, Clone)]
pub struct Dir {
@ -208,7 +218,7 @@ pub fn __dir_runtime(neighbor: &str, path: &str) -> Dir {
///
/// ```
/// fn main() {
/// let content = embed::dir!("../assets");
/// let content: embed::Dir = embed::dir!("../assets");
/// }
/// ```
pub use embed_macros::__dir as dir;