rust-embed

rust macro which loads files into the rust binary at compile time during release and loads the file from the fs during dev.

6e11b751 — Bernardo

update readme

Files changed (1) hide show

readme.md CHANGED Viewed

@@ -23,11 +23,40 @@ You need to add the custom derive macro RustEmbed to your struct with an attribu
 #[folder = "examples/public/"]
 struct Asset;
 ```
-This macro adds a single static method `get` to your type. This method allows you to get your assets from the fs during dev and from the binary during release. It takes the file path as string and returns an `Option` with the bytes.
+The macro will generate the following code:
 ```rust
+impl Asset {
-pub fn get(file_path: &str) -> Option<impl AsRef<[u8]>>
+  pub fn get(file_path: &str) -> Option<impl AsRef<[u8]>> {
+    ...
+  }
+  pub fn iter() -> impl Iterator<Item = impl AsRef<str>> {
+    ...
+  }
+}
 ```
+### `get(file_path: &str)`
+Given a relative path from the assets folder returns the bytes if found.
+If the feature "debug-embed" is enabled or the binary  compiled in release mode the bytes have been embeded in the binary and a `&'static [u8]` is returned.
+Otherwise the bytes are read from the file system on each call and a `Vec<u8>` is returned.
+### `iter()`
+Iterates the files in this assets folder.
+If the feature "debug-embed" is enabled or the binary compiled in release mode a static array to the list of relative paths to the files is returned.
+Otherwise the files are listed from the file system on each call.
 ## Usage
 ```rust
 #[macro_use]