wireforge-io 1.1.0

Cross-platform raw socket I/O — AF_PACKET/BPF/NPcap L2 and raw socket L3
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! WireForge IO — cross-platform raw socket I/O for packet capture and injection.
//!
//! # Platform Support
//!
//! | Platform | L2 Capture | L3 Capture | Backend |
//! |----------|------------|------------|---------|
//! | Linux    | AF_PACKET  | raw socket | socket2 + libc |
//! | macOS    | BPF        | raw socket | /dev/bpf + libc |
//! | Windows  | NPcap      | raw socket | npcap crate |
//!
//! # Quick Start
//!
//! ```rust,no_run
//! # use wireforge_io::{DefaultL2Reader, traits::L2Reader};
//! # fn main() -> Result<(), wireforge_io::IoError> {
//! let mut rx = DefaultL2Reader::new("eth0")?;
//! let eth = rx.recv()?;
//! println!("EtherType: {:?}", eth.ethertype());
//! # Ok(())
//! # }
//! ```
//!
//! # Permissions
//!
//! L2 capture requires root (Linux/macOS) or Administrator (Windows).
//! `list_interfaces()` does not require elevated privileges.

mod common;
mod error;
pub mod traits;

#[cfg(target_os = "linux")]
pub mod linux;
#[cfg(target_os = "macos")]
pub mod macos;
#[cfg(target_os = "windows")]
pub mod windows;

mod interface;

pub use error::IoError;
pub use interface::{list_interfaces, Interface};

// Re-export existing concrete types from their new platform homes
#[cfg(target_os = "linux")]
pub use linux::{L2Receiver, L2Sender, L3Receiver, L3Sender};

// Platform-adaptive type aliases — use these in cross-platform code.
// Each alias resolves to the appropriate platform implementation at compile time.

/// The default L2 frame reader for the current platform.
/// - Linux: [`linux::L2Receiver`] (AF_PACKET)
/// - macOS: [`macos::BpfReader`] (BPF)
/// - Windows: [`windows::NpcapReader`] (NPcap)
#[cfg(target_os = "linux")]
pub type DefaultL2Reader = linux::L2Receiver;
#[cfg(target_os = "macos")]
pub type DefaultL2Reader = macos::BpfReader;
#[cfg(target_os = "windows")]
pub type DefaultL2Reader = windows::NpcapReader;

/// The default L2 frame sender for the current platform.
#[cfg(target_os = "linux")]
pub type DefaultL2Writer = linux::L2Sender;
#[cfg(target_os = "macos")]
pub type DefaultL2Writer = macos::BpfWriter;
#[cfg(target_os = "windows")]
pub type DefaultL2Writer = windows::NpcapWriter;

/// The default L3 IPv4 packet reader for the current platform.
/// - Linux: [`linux::L3Receiver`] (raw socket)
/// - macOS: [`macos::BsdL3Receiver`] (raw socket)
/// - Windows: [`windows::WinL3Receiver`] (raw socket)
#[cfg(target_os = "linux")]
pub type DefaultL3Reader = linux::L3Receiver;
#[cfg(target_os = "macos")]
pub type DefaultL3Reader = macos::BsdL3Receiver;
#[cfg(target_os = "windows")]
pub type DefaultL3Reader = windows::WinL3Receiver;

/// The default L3 IPv4 packet sender for the current platform.
#[cfg(target_os = "linux")]
pub type DefaultL3Writer = linux::L3Sender;
#[cfg(target_os = "macos")]
pub type DefaultL3Writer = macos::BsdL3Sender;
#[cfg(target_os = "windows")]
pub type DefaultL3Writer = windows::WinL3Sender;