#object #elf #mach-o #pe #coff

object

A unified interface for reading and writing object file formats

37 releases (breaking)

0.27.1 Oct 22, 2021
0.26.2 Aug 28, 2021
0.26.0 Jul 26, 2021
0.23.0 Dec 12, 2020
0.1.0 Aug 20, 2016

#8 in macOS and iOS APIs

Download history 361755/week @ 2021-08-15 389585/week @ 2021-08-22 368118/week @ 2021-08-29 343501/week @ 2021-09-05 398210/week @ 2021-09-12 362883/week @ 2021-09-19 349939/week @ 2021-09-26 390321/week @ 2021-10-03 420744/week @ 2021-10-10 449000/week @ 2021-10-17 411312/week @ 2021-10-24 405757/week @ 2021-10-31 397225/week @ 2021-11-07 394673/week @ 2021-11-14 345294/week @ 2021-11-21 384101/week @ 2021-11-28

1,557,427 downloads per month
Used in 3,177 crates (59 directly)

Apache-2.0/MIT

1MB
24K SLoC

object

The object crate provides a unified interface to working with object files across platforms. It supports reading object files and executable files, and writing COFF/ELF/Mach-O object files and ELF/PE executable files.

For reading files, it provides multiple levels of support:

  • raw struct definitions suitable for zero copy access
  • low level APIs for accessing the raw structs (example)
  • a higher level unified API for accessing common features of object files, such as sections and symbols (example)

Supported file formats: ELF, Mach-O, Windows PE/COFF, Wasm, and Unix archive.

Example for unified read API

use object::{Object, ObjectSection};
use std::error::Error;
use std::fs;

/// Reads a file and displays the content of the ".boot" section.
fn main() -> Result<(), Box<dyn Error>> {
  let bin_data = fs::read("./multiboot2-binary.elf")?;
  let obj_file = object::File::parse(&*bin_data)?;
  if let Some(section) = obj_file.section_by_name(".boot") {
    println!("{:#x?}", section.data()?);
  } else {
    eprintln!("section not available");
  }
  Ok(())
}

See crates/examples for more examples.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~135–660KB
~13K SLoC

~ra