sim_connect_rs
| Crates.io | sim_connect_rs |
| lib.rs | sim_connect_rs |
| version | 0.8.2 |
| source | src |
| created_at | 2023-04-17 20:05:16.469486 |
| updated_at | 2023-04-29 05:30:26.73134 |
| description | An easy to use, opinionated API for SimConnect |
| homepage | https://github.com/dbidwell94/simconnect_rs |
| repository | https://github.com/dbidwell94/simconnect_rs |
| max_upload_size | |
| id | 841858 |
| size | 24,534 |
Devin Bidwell (dbidwell94)
documentation
README
sim_connect_rs
An opinionated wrapper around SimConnect which allows safe calling between the C api and Rust. Easy to use, and easy to create new datatypes for use in SimConnect.
Installation
- Install the SimConnect SDK. Instructions located here
- Specify if you want to dynamically or staticly link the library via a feature flag (
static_link)
Cargo Addons
-
static_link- This will tell the compiler to staticly link SimConnect instead of requiring a
.dlldependency
- This will tell the compiler to staticly link SimConnect instead of requiring a
-
async- This will allow you to use asyncrounous versions of this API, such as waiting for data to be retrieved from SimConnect.
-
derive- This will allow you to easily create SimConnect structs by using a
derivemacro
- This will allow you to easily create SimConnect structs by using a
Features
- Async runtime
- data is fetched on a background thread and returned to the client
- Rust style enums
- Use rust enums instead of C-Style vars to communicate with SimConnect
- Auto-struct serialization
- Using the
derivemacro provided, easily create structs which can communicate with SimConnect
- Using the
- Listener based event system
- Instead of polling for events, just subscribe to an event and your callback will be invoked when an event is recieved.