falcon_capstone 0.5.2

Capstone bindings in rust
Documentation 
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

[![Non-Vendored Linux x86_64](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-intel.yml/badge.svg)](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-intel.yml)
[![Vendored Linux x86_64](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-intel.yml/badge.svg)](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-intel.yml)

[![Non-Vendored Linux aarch64](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-aarch64.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-aarch64.yml)
[![Vendored Linux aarch64](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-aarch64.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-aarch64.yml)

[![Non-Vendored Linux Arm7](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-arm7.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/nv-linux-arm7.yml)
[![Vendored Linux Arm7](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-arm7.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/v-linux-arm7.yml)

[![Non-Vendored macOS x86_64](https://github.com/falconre/falcon_capstone/actions/workflows/nv-macos-intel.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/nv-macos-intel.yml)
[![Vendored macOS x86_64](https://github.com/falconre/falcon_capstone/actions/workflows/v-macos-intel.yml/badge.svg?branch=master)](https://github.com/falconre/falcon_capstone/actions/workflows/v-macos-intel.yml)

# falcon_capstone

This is a fork of Mm7's capstone bindings for Rust, which can be found [here](https://github.com/Mm7/capstone-rust/).

### Requirements
- Rust edition 2021 (1.56+)

### Usage
#### Vendored

Vendored work thanks to @marirs and @mnaza.

In Cargo.toml include
```toml
[dependencies]
falcon_capstone = { git = "https://github.com/falconre/falcon_capstone", branch = "master", features = ["vendored"] }
```

#### Non Vendored

#### Requirements for non vendored compile
- Libcapstone
  - linux: apt-get install -y libcapstone-dev
  - mac: brew install capstone
- Clang/LLVM

In Cargo.toml include
```toml
[dependencies]
falcon_capstone = { git = "https://github.com/falconre/falcon_capstone", branch = "master" }
```

#### Troubleshooting
For any reason if its not getting compiled in macOS complaining about `capstone/capstone.h not found` although you have it, compile using the following method:
```bash
CPATH="/usr/local/include" LIBRARY_PATH="/usr/local/lib" cargo b
```
assuming that `/usr/local/include` has the header files of capstone and `/usr/local/lib` having the capstone lib files.
This is because CLANG in macOS has its `include` and `lib` path in a different folder location which might not be in the search path.

---
License: LGPL-3