Note
The API is documented here https://lief.re/doc/stable/rust/lief and the nightly doc is here: https://lief-rs.s3.fr-par.scw.cloud/doc/latest/lief/index.html.
[package]
name = "my-awesome-project"
version = "0.0.1"
edition = "2021"
[dependencies]
lief = { git = "https://github.com/lief-project/LIEF", branch = "main" }
Warning
LIEF rust bindings are not on docs.rs because of network restrictions: https://github.com/rust-lang/docs.rs/issues/2563
LIEF’s Rust bindings are split into two parts:
lief: the high-level, idiomatic Rust API.
lief-ffi: the low-level FFI API generated by autocxx.
Compiling the lief-ffi package can take several minutes. However, most of this time is spent compiling auto-generated C++ code (generated by cxx.rs).
Similarly, the .rs file generated by autocxx does not need to be regenerated for every build. For a specific tag or commit, these files can be pre-compiled or pre-generated.
To save time, LIEF provides pre-compiled versions of these elements, which are downloaded from GitHub (for releases) or an S3 bucket (for nightly builds). If you need to avoid downloading these pre-compiled files, set This variable can also be used when building in offline mode (e.g., As of now, the following targets are supported with pre-compilation: Target Description Regular Linux x86-64 (Ubuntu 19.10, Debian 10, …) Regular Linux i686 (Ubuntu 19.10, Debian 10, …) Musl target that allows full static build Linux i686 with Musl Linux aarch64 (Debian 12+) Linux aarch64 with Musl macOS 11+ x86-64 macOS 11+ arm64 (Apple Silicon) iOS 12+ Regular Windows x86-64 (static UCRT runtime) Regular Windows x86-64 (dynamic UCRT runtime Regular Windows arm64 (static UCRT runtime) Regular Windows arm64 (dynamic UCRT runtime The assets of the pre-compiled output are: LIEF static library: The LIEF static library must be compiled as described in the Compilation section using the CMake option: The LIEF_RUST_PRECOMPILED¶LIEF_RUST_PRECOMPILED to point to the directory that contains these files:/home/romain/out
├── lib
│ ├── libLIEF.a
│ └── liblief-sys.a
└── rs
└── autocxx-autocxx_ffi-gen.rs
3 directories, 3 files
LIEF_RUST_PRECOMPILED=/home/romain/out cargo build [...]
cargo --offline).x86_64-unknown-linux-gnui686-unknown-linux-gnux86_64-unknown-linux-musli686-unknown-linux-muslaarch64-unknown-linux-gnuaarch64-unknown-linux-muslx86_64-apple-darwinaarch64-apple-darwinaarch64-apple-iosx86_64-pc-windows-msvc[MT]x86_64-pc-windows-msvc[MD].dll)aarch64-pc-windows-msvc[MT]aarch64-pc-windows-msvc[MD].dll)Precompilation¶
LIEF.a, LIEF.libliefsys.{a, lib}: C++ part of cxx.rsautocxx-autocxx_ffi-gen.rs: bridge generated by autocxx.-DLIEF_RUST_API=ON.liefsys.{a, lib} and autocxx-autocxx_ffi-gen.rs can be generated using the lief-ffigen module:$ cd api/rust/cargo
$ cargo build --release -p lief-ffigen
$ ./target/release/lief-ffigen \
--output-dir ./out-gen \
--lief-dir <path-to-lief-sdk> \
--target x86_64-unknown-linux-gnu \
--host x86_64-unknown-linux-gnu
--lief-dir option must point to the install location of the SDK, and out-gen/ will contain the generated artifacts.