首页
/ 雅兰亭库 (yalantinglibs) 使用教程

雅兰亭库 (yalantinglibs) 使用教程

2024-08-07 10:55:38作者:瞿蔚英Wynne

1. 项目的目录结构及介绍

雅兰亭库 (yalantinglibs) 是一个现代 C++ 基础工具库的集合,其 GitHub 仓库的目录结构如下:

yalantinglibs/
├── include/
│   └── ylt/
│       ├── struct_pack/
│       ├── struct_json/
│       ├── struct_xml/
│       ├── struct_yaml/
│       ├── easylog/
│       ├── coro_rpc/
│       ├── coro_http/
│       └── async_simple/
├── src/
│   ├── struct_pack/
│   ├── struct_json/
│   ├── struct_xml/
│   ├── struct_yaml/
│   ├── easylog/
│   ├── coro_rpc/
│   ├── coro_http/
│   └── async_simple/
├── examples/
│   ├── struct_pack/
│   ├── struct_json/
│   ├── struct_xml/
│   ├── struct_yaml/
│   ├── easylog/
│   ├── coro_rpc/
│   ├── coro_http/
│   └── async_simple/
├── tests/
│   ├── struct_pack/
│   ├── struct_json/
│   ├── struct_xml/
│   ├── struct_yaml/
│   ├── easylog/
│   ├── coro_rpc/
│   ├── coro_http/
│   └── async_simple/
├── CMakeLists.txt
├── README.md
└── LICENSE

目录介绍

  • include/ylt/:包含所有库的头文件。
  • src/:包含所有库的源文件。
  • examples/:包含每个库的使用示例。
  • tests/:包含每个库的测试代码。
  • CMakeLists.txt:CMake 构建配置文件。
  • README.md:项目介绍和使用说明。
  • LICENSE:项目许可证文件。

2. 项目的启动文件介绍

雅兰亭库 (yalantinglibs) 是一个头文件库,因此没有特定的启动文件。用户可以根据需要包含相应的头文件并编写代码。例如,使用 struct_pack 库时,可以包含以下头文件:

#include <ylt/struct_pack.hpp>

3. 项目的配置文件介绍

雅兰亭库 (yalantinglibs) 的配置主要通过 CMake 选项进行。以下是一些常用的配置选项:

  • YLT_ENABLE_SSL:启用可选的 SSL 支持。
  • YLT_ENABLE_PMR:启用 PMR 优化。
  • YLT_ENABLE_IO_URING:在 Linux 上启用 io_uring。
  • YLT_ENABLE_FILE_IO_URING:在 Linux 上启用文件 io_uring 作为后端。
  • YLT_ENABLE_STRUCT_PACK_UNPORTABLE_TYPE:启用 struct_pack 的不便携类型(如 wstringint128_t)。
  • YLT_ENABLE_STRUCT_PACK_OPTIMIZE:通过激进的模板展开优化 struct_pack(会增加编译时间)。

配置示例

在 CMake 中启用 SSL 支持:

cmake -DYLT_ENABLE_SSL=ON ..

通过这些配置选项,用户可以根据项目需求灵活地配置雅兰亭库 (yalantinglibs)。

登录后查看全文