2 releases
0.1.1 | May 12, 2021 |
---|---|
0.1.0 | May 12, 2021 |
#707 in Configuration
13KB
158 lines
elfredo
There are two main components to any project that uses elfredo:
- Customizing your embeditor to mach your datatype (step 1)
- Calling the
get_embedded_data
method to retrieve the embedded data (step 2)
After these two are implemented you end up with two binaries:
- [app executable].elf - Your editable app
- [embeditor executable].elf - The binary that you use to change the embedded data
Steps to integrate (See ./example
):
- Write your configurable data structure in the embeditor binary:
// my_embeditor.rs
use elfredo::embeditor::run_embeditor;
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize, Debug)]
pub struct Person {
name: String,
id: u32,
}
fn main() {
// This will print the embedded data if exists
if let Err(err) = run_embeditor::<Person>() {
panic!("{}", err);
}
}
- Read the configurations by using elfredo's api:
// main.rs
use elfredo::get_embedded_data;
mod my_embeditor;
use my_embeditor::Person;
fn main() -> Result<(), failure::Error> {
let person = get_embedded_data::<Person>().unwrap();
println!("{:?}", person);
Ok(())
}
- Embed new data to the elf
john@ubuntu:/mnt/hgfs/elfredo/example$ cat person.json
{
"name": "Ronald",
"id": 5
}
john@ubuntu:/mnt/hgfs/elfredo/example$ cargo run --bin embeditor ../target/debug/example person.json
Compiling elfredo v0.1.0 (/mnt/hgfs/elfredo)
Compiling example v0.1.0 (/mnt/hgfs/elfredo/example)
Finished dev [unoptimized + debuginfo] target(s) in 24.99s
Running `/mnt/hgfs/elfredo/target/debug/embeditor ../target/debug/example person.json`
"/tmp/.tmpXh5QHg"
john@ubuntu:/mnt/hgfs/elfredo/example$ ../target/debug/example
Person { name: "Ronald", id: 5 }
Dependencies
~8–18MB
~258K SLoC