r_lanlib/lib.rs
1//! Library package for performing network scanning of any LAN
2//!
3//! This is the rust version of [go-lanscan package](https://github.com/robgonnella/go-lanscan)
4//!
5//! # Examples
6//!
7//! ## ARP Scanning
8//!
9//! <https://github.com/robgonnella/r-lanscan/blob/main/lib/examples/arp-scanner.rs>
10//!
11//! ```bash
12//! sudo -E cargo run --example arp-scanner -p r-lanlib
13//! ```
14//!
15//! ## SYN Scanning
16//!
17//! <https://github.com/robgonnella/r-lanscan/blob/main/lib/examples/syn-scanner.rs>
18//!
19//! ```bash
20//! sudo -E cargo run --example syn-scanner -p r-lanlib
21//! ```
22//!
23//! ## Full Scanning (ARP + SYN)
24//!
25//! <https://github.com/robgonnella/r-lanscan/blob/main/lib/examples/full-scanner.rs>
26//!
27//! ```bash
28//! sudo -E cargo run --example full-scanner -p r-lanlib
29//! ```
30
31#![deny(missing_docs)]
32pub mod error;
33pub mod network;
34pub mod packet;
35pub mod scanners;
36pub mod targets;