openlark_core/
lib.rs

1//! OpenLark Core Infrastructure
2//!
3//! This crate provides the core infrastructure for the OpenLark SDK including
4//! HTTP client configuration, error handling, authentication, and common utilities.
5
6// 对外稳定导出：尽量保持"少而清晰"的公共 API（KISS）
7pub mod api;
8pub mod auth;
9/// 客户端配置模块（Config、ConfigBuilder 等）
10pub mod config;
11/// 全局常量定义（URL、错误码前缀、超时配置等）
12pub mod constants;
13/// 统一错误处理模块（CoreError、错误码、错误上下文等）
14pub mod error;
15/// HTTP 客户端模块（Transport、请求构建等）
16pub mod http;
17pub(crate) mod observability;
18pub(crate) mod query_params;
19/// 请求选项模块（RequestOption、自定义头部、租户键等）
20pub mod req_option;
21pub(crate) mod request_builder;
22/// Security utilities for handling sensitive data
23pub mod security;
24#[cfg(feature = "testing")]
25pub mod testing;
26pub mod trait_system;
27pub mod validation;
28
29// crate 内部实现细节：不对外暴露（避免把 core 变成"全家桶"）
30// 已移动到 auth::app_ticket
31mod content_disposition;
32mod performance;
33mod req_translator;
34mod response_handler;
35mod utils;
36
37// Re-export commonly used types from crate root
38pub use error::{CoreError, SDKResult, validation_error};
39pub use validation::Validatable;
40
41// Re-export validate_required macro for docs module
42/// 验证必填字段（检查非空白字符串）
43///
44/// # 参数
45/// - `$field`: 要验证的字段
46/// - `$error_msg`: 错误消息
47///
48/// # 使用示例
49/// ```rust,ignore
50/// validate_required!(self.user_id, "用户 ID 不能为空");
51/// ```
52#[macro_export]
53macro_rules! validate_required {
54    ($field:expr, $error_msg:expr) => {
55        if $crate::Validatable::is_empty_trimmed(&$field) {
56            return Err($crate::error::CoreError::validation_msg($error_msg));
57        }
58    };
59}
60
61/// 验证必填列表字段（检查非空和最大长度）
62///
63/// # 参数
64/// - `$field`: 要验证的列表字段
65/// - `$max_len`: 最大长度限制
66/// - `$error_msg`: 错误消息
67///
68/// # 使用示例
69/// ```rust,ignore
70/// validate_required_list!(self.user_ids, 50, "用户 ID 列表不能为空且不能超过 50 个");
71/// ```
72#[macro_export]
73macro_rules! validate_required_list {
74    ($field:expr, $max_len:expr, $error_msg:expr) => {
75        if $field.is_empty() {
76            return Err($crate::error::CoreError::validation_msg($error_msg));
77        }
78        if $field.len() > $max_len {
79            return Err($crate::error::CoreError::validation_msg($error_msg));
80        }
81    };
82}
83
84/// Prelude module for convenient imports.
85pub mod prelude {
86    // Re-export new API module（请求/响应基础类型）
87    pub use crate::api::prelude::*;
88
89    // Re-export commonly used core modules directly（最小集合）
90    pub use crate::config::Config;
91    pub use crate::constants::*;
92    pub use crate::error::{CoreError, SDKResult, validation_error};
93    pub use crate::http::Transport;
94    pub use crate::req_option::*;
95    pub use crate::validate_required;
96    pub use crate::validate_required_list;
97}
openlark_core/lib.rs

openlark_core/
lib.rs
