Skip to content

Commit

Permalink
v0.4.1: Updated crate documentation. (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
wiresock authored May 28, 2023
1 parent 21aa4c3 commit 5e9d2c4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ndisapi-rs"
version = "0.4.0"
version = "0.4.1"
edition = "2021"
authors = ["Vadim Smirnov <[email protected]>"]
description = "Windows Packet Filter API for Rust"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Add the following to your `Cargo.toml` file:

```toml
[dependencies]
ndisapi-rs = "0.4.0"
ndisapi-rs = "0.4.1"
```

## Usage
Expand Down
15 changes: 12 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
//! The NDISAPI crate is a Rust library that provides functionality for capturing and filtering network packets
//! on Windows operating systems. The crate contains three main modules: driver, ndisapi, and net.
//! on Windows operating systems. The crate contains the following main modules: driver, ndisapi, async_api, and main.
//!
//! ## driver
//! The driver module provides low-level functionality for interacting with Windows device drivers, and is used
//! by the ndisapi module to capture and filter network packets.
//!
//! ## ndisapi
//! The ndisapi module contains the main functionality for capturing and filtering network packets.
//! This includes various structs and enums for representing packet data and filter settings, as well as a Ndisapi
//! This includes various structs and enums for representing packet data and filter settings, as well as an Ndisapi
//! struct for interacting with the driver and performing packet capture and filtering operations.
//!
//! The net module contains a MacAddress struct for representing and manipulating MAC addresses.
//! ## async_io
//! The async_io module provides asynchronous methods for managing and interacting with the network adapter. This includes
//! reading and writing Ethernet packets, and adjusting adapter settings. This is achieved through the use of `async` functions,
//! which allow these operations to be performed without blocking the rest of your application.
//!
//! ## netlib
//! The netlib module provides functionality for interacting with the Windows IP Helper API. This includes structs and enums
//! for representing network adapter information, IP addresses, and other network-related data.
mod async_api;
mod driver;
Expand Down

0 comments on commit 5e9d2c4

Please sign in to comment.