Skip to main content

Crate open_lark

Crate open_lark 

Source
Expand description

OpenLark 官方入口 crate。

普通用户应优先使用 openlark,通过业务 feature 开启所需能力:

[dependencies]
openlark = { version = "0.16.0", default-features = false, features = ["auth", "docs-drive", "docs-bitable", "webhook-signature"] }
  • 统一客户端入口:Client
  • 高级业务模块入口:auth、[communication]、[docs]、[workflow] 等
  • 统一预导出:prelude

若只想要单一业务域的最小依赖,再直接使用 openlark-{domain} 子 crate。

Canonical public API 入口规则见 docs/PUBLIC_REEXPORT_POLICY.md

推荐顺序:

  • 运行时入口:Client / ClientBuilder
  • 导入入口:prelude
  • 业务命名空间:open_lark::authopen_lark::communicationopen_lark::docs
  • 最小依赖场景:直接依赖对应 openlark-{domain} crate

顶层 AuthClientDocsClientHrClient 等类型 re-export 会继续保留, 但它们的定位是 compatibility alias,而不是普通用户的主入口。

根 crate prelude 有意不暴露客户端实现层细节:

use open_lark::prelude::*;

let _registry: ServiceRegistry;

Modules§

prelude
面向 openlark 用户的统一预导出。

Structs§

Client
🚀 OpenLark客户端 - 极简设计
ClientBuilder
🏗️ 客户端构建器 - 流畅API
Config
🔧 OpenLark客户端配置
CoreConfig
零拷贝配置共享实现
RequestOption
请求选项

Enums§

CoreError
轻量版核心错误
ErrorCode
标准错误码枚举
ErrorSeverity
错误严重程度
ErrorType
错误类型分类

Traits§

ErrorTrait
核心错误特征

Type Aliases§

Error
🚨 OpenLark 客户端错误类型
Result
📦 客户端结果类型别名
SDKResult
SDK 操作结果类型别名