embeddy 0.1.1

Resource embedding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! # Embedding
//!
//! To embed a folder simply derive the [`Embedded`] trait on
//! a struct and set the `folder` attribute to the folder path
//! relative to the project Cargo.toml
//!
//! ```
//! use embeddy::Embedded;
//!
//! #[derive(Embedded)]
//! #[folder = "test"]
//! struct MyResources;
//!
//! fn main() {
//!     let file: Option<&'static [u8]> = MyResources::get("test.txt");
//! }
//!
//! ```
pub use embeddy_derive::Embedded;

/// Trait implemented on structures that store
/// embedded resources
pub trait Embedded {
    /// Returns the bytes stored at the provided file path if
    /// there is a file present for that path
    fn get(path: &str) -> Option<&'static [u8]>;
}