https://github.com/edigaryev/vmnet
Apple's vmnet.framework bindings for Rust
https://github.com/edigaryev/vmnet
networking rust vmnet
Last synced: 4 months ago
JSON representation
Apple's vmnet.framework bindings for Rust
- Host: GitHub
- URL: https://github.com/edigaryev/vmnet
- Owner: edigaryev
- License: mit
- Created: 2022-06-02T16:46:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T21:31:20.000Z (over 1 year ago)
- Last Synced: 2025-02-28T04:47:20.464Z (about 1 year ago)
- Topics: networking, rust, vmnet
- Language: Rust
- Homepage:
- Size: 47.9 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vmnet
[](https://docs.rs/vmnet)
Apple's [`vmnet.framework`](https://developer.apple.com/documentation/vmnet) bindings for Rust.
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
vmnet = "0"
```
## Usage
Ensure that your software either has an `com.apple.vm.networking` entitlement or is running with elevated privileges.
Start a NAT interface and receive some packets destined to it:
```rust
let shared_mode = Shared {
subnet_options: None,
..Default::default()
};
let mut iface = Interface::new(Mode::Shared(shared_mode), Options::default()).unwrap();
let (tx, rx) = sync::mpsc::sync_channel(0);
iface.set_event_callback(Events::PACKETS_AVAILABLE, move |events, params| {
if let Some(Parameter::EstimatedPacketsAvailable(pkts)) = params.get(ParameterKind::EstimatedPacketsAvailable) {
tx.send(pkts);
}
}).unwrap();
let pkts = rx.recv().unwrap();
println!("receiving {} packets...", pkts);
for _ in 0..pkts {
let mut buf: [u8; 1514] = [0; 1514];
println!("{:?}", iface.read(&mut buf));
}
drop(rx);
iface.finalize().unwrap();
```
## Quirks
* due to Apple's usage of [blocks](https://en.wikipedia.org/wiki/Blocks_(C_language_extension)) as a way to retrieve API call results, some methods like `set_event_callback()` require the provided closure to have a `'static` lifetime
* this manifests itself in not being able to use `Interface` from such closure
* however, this can be easily worked around by using [interior mutability pattern](https://doc.rust-lang.org/book/ch15-05-interior-mutability.html) or simply by using the callback as a signal carrier
* due to `API_AVAILABLE` macro not being supported it is assumed that this package is running on macOS 15.0 or newer