qmt-parser 0.1.0

Rust parser for MiniQMT/QMT local market data, finance files, and dividend metadata.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

#![warn(missing_docs)]
//! `qmt-parser` 提供面向 MiniQMT / QMT 本地数据目录的解析能力。
//!
//! 这个 crate 主要覆盖三类能力：
//!
//! - 历史行情 `.dat` 文件解析：tick、1 分钟线、日线
//! - 可选的 Polars `DataFrame` 输出
//! - QMT 本地财务与分红数据读取
//!
//! 大多数用户可以直接从 crate 根模块调用重导出的顶层函数，例如
//! [`parse_ticks_to_structs`]、[`parse_min_to_structs`]、
//! [`parse_daily_to_structs`] 或 [`FinanceReader::read_file`]。
//!
//! # Feature Flags
//!
//! - `polars`：默认开启，启用 `parse_*_to_dataframe` 系列接口
//!
//! # Quick Start
//!
//! 解析 tick 文件为结构体：
//!
//! ```no_run
//! use qmt_parser::parse_ticks_to_structs;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let ticks = parse_ticks_to_structs("data/000001-20250529-tick.dat")?;
//! println!("rows = {}", ticks.len());
//! # Ok(())
//! # }
//! ```
//!
//! 解析日线并限制日期范围：
//!
//! ```no_run
//! use qmt_parser::parse_daily_to_structs;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let rows = parse_daily_to_structs("data/day/000001.dat", "20230101", "20231231")?;
//! println!("rows = {}", rows.len());
//! # Ok(())
//! # }
//! ```
//!
//! 在启用 `polars` feature 时生成 `DataFrame`：
//!
//! ```no_run
//! # #[cfg(feature = "polars")]
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use qmt_parser::parse_min_to_dataframe;
//!
//! let df = parse_min_to_dataframe("data/000001-1m.dat")?;
//! println!("{:?}", df.shape());
//! # Ok(())
//! # }
//! #
//! # #[cfg(not(feature = "polars"))]
//! # fn main() {}
//! ```
//!
//! # Modules
//!
//! - [`tick`]：Tick 分笔解析
//! - [`min`]：1 分钟 K 线解析
//! - [`day`]：日线解析与派生列处理
//! - [`finance`]：财务 `.DAT` 解析
//! - [`dividend`]：分红送配 LevelDB 查询
//! - [`error`]：公共错误类型

/// 日线解析与 DataFrame 导出。
pub mod day;
/// 分红送配 LevelDB 查询。
pub mod dividend;
/// 公开错误类型定义。
pub mod error;
/// QMT 财务 `.DAT` 解析。
pub mod finance;
/// 1 分钟 K 线解析与 DataFrame 导出。
pub mod min;
/// Tick 分笔解析与 DataFrame 导出。
pub mod tick;

/// 日线 DataFrame 的输出列名。
pub use day::daily_dataframe_column_names;
pub use day::{DailyKlineData, DailyReader};
#[cfg(feature = "polars")]
pub use day::{
    parse_daily_file_to_dataframe, parse_daily_to_dataframe, parse_daily_to_dataframe_in_range,
};
pub use day::{
    parse_daily_file_to_structs, parse_daily_to_structs, parse_daily_to_structs_in_range,
};
pub use dividend::{DividendDb, DividendError, DividendRecord};
pub use error::{DailyParseError, MinParseError, TickParseError};
pub use finance::{FileType, FinanceData, FinanceError, FinanceReader, FinanceRecord, Shareholder};
/// 分钟线 DataFrame 的输出列名。
pub use min::min_dataframe_column_names;
#[cfg(feature = "polars")]
pub use min::parse_min_to_dataframe;
pub use min::{MinKlineData, MinReader, parse_min_to_structs};
#[cfg(feature = "polars")]
pub use tick::parse_ticks_to_dataframe;
pub use tick::{
    FULL_TICK_API_FIELD_NAMES, TICK_DATAFRAME_COLUMN_NAMES, tick_api_field_names,
    tick_dataframe_column_names,
};
pub use tick::{TickData, TickReader, parse_ticks_to_structs};