-
Notifications
You must be signed in to change notification settings - Fork 1
API Reference
ChouChiu edited this page Sep 23, 2026
·
3 revisions
门面 crate lyrics-helper 重新导出了子 crate 的全部公开类型与函数,通常直接使用 use lyrics_helper::*;。
| 函数 / 类型 | 说明 |
|---|---|
parse_auto(input) -> Option<LyricsData> |
自动识别格式并解析 |
parse(input, raw_type) -> Option<LyricsData> |
按指定格式解析 |
parser_for(raw_type) -> Option<&'static dyn LyricsParser> |
获取指定格式的解析器实例;信封格式及 Unknown 返回 None
|
generate_string(data, lyrics_type) -> Option<String> |
将歌词数据导出为目标格式文本 |
generator_for(lyrics_type) -> Option<&'static dyn LyricsGenerator> |
获取指定格式的生成器实例;无对应生成器的格式返回 None
|
decrypt_qrc(encrypted) -> Option<String> |
解密 QQ 音乐十六进制 QRC 密文 |
decrypt_krc(encrypted) -> Option<String> |
解密酷狗 Base64 编码的 KRC 密文 |
QrcDecrypter / KrcDecrypter
|
实现 LyricsDecrypter 的解密器类型,失败时返回具体 DecryptError
|
| 路径 | 内容 |
|---|---|
lyrics_helper::{LyricsData, LineInfo, SyllableItem, …} |
核心数据模型与枚举(重导出自 lyrics-core) |
lyrics_helper::helpers::* |
格式检测、时间偏移、中文转换、书写约定、逐词计时与优化器 |
lyrics_helper::traits::* |
LyricsParser、LyricsGenerator、LyricsDecrypter 及 DecryptError
|
lyrics_helper::parsers::parsers::* |
各格式独立解析器模块(如 lrc_parser、qrc_parser 等) |
lyrics_helper::parsers::xml_utils |
QRC XML 信封的提取与清洗 |
lyrics_helper::generators::* |
各格式独立生成器模块 |
lyrics_helper::decrypter::* |
QRC/KRC 解密与网易云 eapi 参数加密实现 |
lyrics_helper::searchers::* [search]
|
各平台搜索客户端、打分与渐进式搜索函数 |
lyrics_helper::providers::web::* [search]
|
底层平台 HTTP 接口客户端 |
lyrics_helper::SearchError [search]
|
搜索层统一错误类型 |
[search] 标记项需要启用默认的
searchfeature。
| 操作需求 | 参考文档 |
|---|---|
| 解析指定或未知格式的歌词 | 快速开始、解析 / 生成 / 解密 |
| 查阅字段定义、变体与方法 | 数据结构、枚举类型 |
| 查阅格式转换规则与兼容矩阵 | 支持的格式 |
| 在线检索歌曲与抓取歌词 | 搜索功能、搜索类型与高级函数 |
| 解密 QRC 与 KRC | 歌词解密 |
| 时间校准、繁简转换与书写约定 | 辅助工具 |
| 版本升级指南 | 从 0.4 升级到 0.5、从 0.3 升级到 0.4 |