lief 1.0.0

Official Rust bindings for LIEF
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
28
29
30
31
32
33
34

use lief_ffi as ffi;
use std::path::Path;

/// Enable globally cache/memoization. One can also leverage this function
/// by setting the environment variable `DYLDSC_ENABLE_CACHE` to `1`
///
/// By default, LIEF will use the directory specified by the environment
/// variable `DYLDSC_CACHE_DIR` as its cache-root directory:
///
/// ```bash
/// DYLDSC_ENABLE_CACHE=1 DYLDSC_CACHE_DIR=/tmp/my_dir ./my-program
/// ```
///
/// Otherwise, if `DYLDSC_CACHE_DIR` is not set, LIEF will use the following
/// directory (in this priority):
///
/// 1. System or user cache directory
///   - macOS: `DARWIN_USER_TEMP_DIR` / `DARWIN_USER_CACHE_DIR` + `/dyld_shared_cache`
///   - Linux: `${XDG_CACHE_HOME}/dyld_shared_cache`
///   - Windows: `%LOCALAPPDATA%\dyld_shared_cache`
/// 2. Home directory
///   - macOS/Linux: `$HOME/.dyld_shared_cache`
///   - Windows: `%USERPROFILE%\.dyld_shared_cache`
///
/// See [`crate::dsc::DyldSharedCache::enable_caching`] for a finer granularity
pub fn enable_cache() -> bool {
    ffi::dsc_enable_cache()
}

/// Same behavior as [`enable_cache`] but with a user-provided cache directory
pub fn enable_cache_from_dir<P: AsRef<Path>>(target_dir: P) -> bool {
    cxx::let_cxx_string!(__cxx_s = target_dir.as_ref().to_str().unwrap());
    ffi::dsc_enable_cache_from_dir(&__cxx_s)
}