pcapfile_io/
lib.rs

1//! # PcapFile.IO - 高性能PCAP文件读写库
2//!
3//! 这是一个用Rust编写的高性能PCAP文件处理库,提供了完整的PCAP文件读写功能。
4//! 采用标准四层架构设计,确保系统的可维护性和可扩展性。
5//!
6//! ## 架构设计
7//!
8//! ```text
9//! +-------------------------------------+
10//! |    用户接口层 (API Layer)           |  <- 对外提供服务接口
11//! +-------------------------------------+
12//! |    业务逻辑层 (Business Layer)      |  <- 核心业务逻辑实现
13//! +-------------------------------------+
14//! |    数据访问层 (Data Layer)          |  <- 数据操作和格式处理
15//! +-------------------------------------+
16//! |    基础设施层 (Foundation)          |  <- 工具函数和通用组件
17//! +-------------------------------------+
18//! ```
19//!
20//! ## 特性
21//!
22//! - 🚀 **高性能**: 零拷贝操作和编译时优化
23//! - 🔒 **内存安全**: Rust的内存安全保证
24//! - 🧵 **线程安全**: 内置线程安全支持
25//! - 📦 **易于使用**: 简洁的API设计
26//! - 🔧 **可配置**: 灵活的配置选项
27//! - 📊 **完整功能**: 支持所有PCAP格式特性
28//! - 📋 **索引支持**: 高性能PIDX索引文件处理
29//!
30
31// 分层架构模块声明
32pub mod api;
33pub mod business;
34pub mod data;
35pub mod foundation;
36
37// 重新导出核心类型和函数
38pub use business::{
39    PacketIndexEntry, PcapFileIndex, PidxIndex,
40    ReaderConfig, WriterConfig,
41};
42pub use data::{
43    DataPacket, DataPacketHeader, DatasetInfo, FileInfo,
44    PcapFileHeader,
45};
46pub use foundation::{PcapError, PcapResult};
47
48// 基础设施层类型导出
49pub use foundation::{constants, PcapErrorCode};
50
51// 用户接口层导出(主要API)
52// 索引功能通过 PcapReader.index() 和 PcapWriter.index() 访问
53pub use api::{PcapReader, PcapWriter};
54
55// 版本信息
56pub const VERSION: &str = env!("CARGO_PKG_VERSION");
57pub const AUTHORS: &str = env!("CARGO_PKG_AUTHORS");
58pub const DESCRIPTION: &str = env!("CARGO_PKG_DESCRIPTION");
59
60/// 获取库版本信息
61pub fn version_info() -> &'static str {
62    VERSION
63}
64
65/// 获取库作者信息
66pub fn authors_info() -> &'static str {
67    AUTHORS
68}
69
70/// 获取库描述信息
71pub fn description_info() -> &'static str {
72    DESCRIPTION
73}