Skip to main content

yang_base/
lib.rs

1//! yang-base - YANG 基础库
2//!
3//! 提供插件管理、数据库访问、HTTP 客户端和 JWT Token 管理等核心功能。
4//!
5//! # 模块
6//!
7//! - `plugin`:插件管理模块
8//! - `database`:数据库管理模块(支持 MySQL 和 Redis)
9//! - `http`:HTTP 客户端模块(需启用 `http` feature)
10//! - `token`:JWT Token 管理模块(需启用 `token` feature)
11//! - `error`:错误处理模块
12//! - `table`:表配置系统模块
13//! - `action`:Action 系统模块
14//!
15//! # Feature Gates
16//!
17//! - `token`:启用 JWT Token 管理功能(依赖 `jsonwebtoken`)
18//! - `http`:启用 HTTP 客户端功能(依赖 `reqwest`、`serde_urlencoded`)
19//! - `mysql`:启用 MySQL 数据库查询执行功能(依赖 `sqlx`)
20//! - `validator`:启用正则表达式校验器(依赖 `regex`)
21//! - `plugin-schema`:启用插件 JSON Schema 配置验证(依赖 `jsonschema`)
22//!
23//! # 快速开始
24//!
25//! ```rust,ignore
26//! use yang_base::plugin::{Plugin, PluginManager};
27//! use yang_base::database::{GlobalDatabase, GlobalRedis};
28//! use yang_base::http::HttpClient;
29//! use yang_base::token::TokenManager;
30//! use yang_db::{DatabaseConfig, redis::RedisConfig};
31//!
32//! #[tokio::main]
33//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
34//!     // 初始化插件管理器
35//!     let plugin_manager = PluginManager::new();
36//!     
37//!     // 初始化全局 MySQL 数据库
38//!     GlobalDatabase::init("mysql://user:pass@localhost/db", DatabaseConfig::default()).await?;
39//!     
40//!     // 初始化全局 Redis
41//!     GlobalRedis::init("redis://127.0.0.1:6379", RedisConfig::default()).await?;
42//!     
43//!     // 初始化 HTTP 客户端
44//!     HttpClient::init_global(30)?;
45//!     
46//!     // 使用 MySQL
47//!     let users = GlobalDatabase::table("users")?
48//!         .select::<User>()
49//!         .await?;
50//!     
51//!     // 使用 Redis
52//!     GlobalRedis::set("key", "value", None).await?;
53//!     let value = GlobalRedis::get("key").await?;
54//!     
55//!     Ok(())
56//! }
57//! ```
58
59// 强制公开 API 文档覆盖率检查:所有公开项必须有文档注释
60#![warn(missing_docs)]
61
62pub mod action;
63pub mod database;
64pub mod error;
65#[cfg(feature = "http")]
66pub mod http;
67pub mod plugin;
68pub mod router;
69pub mod table;
70#[cfg(feature = "token")]
71pub mod token;
72
73// 重新导出插件系统的核心类型,方便用户直接使用
74pub use plugin::{Plugin, PluginManager, PluginManagerBuilder, PluginRegistry};