共享库文档¶
Shortener Common 是一个共享库,包含 shortener-server 和 shortener-cli 使用的通用类型和工具。
📦 内容¶
数据类型¶
共享的数据结构定义,确保服务器和 CLI 之间的类型一致性。
工具函数¶
通用的工具函数,避免代码重复。
常量定义¶
项目中使用的常量定义。
错误类型¶
统一的错误处理类型。
🔧 使用¶
在 Cargo.toml 中添加依赖:
在代码中使用:
📖 API 文档¶
运行以下命令生成 API 文档:
🛠️ 开发¶
添加新类型¶
在 src/types.rs 中添加新的类型定义。
添加新工具¶
在 src/utils.rs 中添加新的工具函数。
测试¶
📝 注意事项¶
- 保持类型定义的简洁性
- 确保向后兼容性
- 为公共 API 添加文档注释
- 编写单元测试