README.md
1# `object`
2
3The `object` crate provides a unified interface to working with object files
4across platforms. It supports reading object files and executable files,
5and writing object files.
6
7For reading files, it provides multiple levels of support:
8
9* raw struct definitions suitable for zero copy access
10* low level APIs for accessing the raw structs
11* a higher level unified API for accessing common features of object files, such
12 as sections and symbols
13
14Supported file formats: ELF, Mach-O, Windows PE/COFF, Wasm, and Unix archive.
15
16## Example for unified read API
17```rust
18use object::{Object, ObjectSection};
19use std::error::Error;
20use std::fs;
21
22/// Reads a file and displays the content of the ".boot" section.
23fn main() -> Result<(), Box<dyn Error>> {
24 let bin_data = fs::read("./multiboot2-binary.elf")?;
25 let obj_file = object::File::parse(&*bin_data)?;
26 if let Some(section) = obj_file.section_by_name(".boot") {
27 println!("{:#x?}", section.data()?);
28 } else {
29 eprintln!("section not available");
30 }
31 Ok(())
32}
33```
34
35## License
36
37Licensed under either of
38
39 * Apache License, Version 2.0 ([`LICENSE-APACHE`](./LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
40 * MIT license ([`LICENSE-MIT`](./LICENSE-MIT) or http://opensource.org/licenses/MIT)
41
42at your option.
43
44## Contribution
45
46Unless you explicitly state otherwise, any contribution intentionally submitted
47for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
48dual licensed as above, without any additional terms or conditions.
49