Skip to main content

yang_base/action/
meta.rs

1//! Action 运行时元信息聚合
2//!
3//! 由 `#[derive(Action)]` 在 `meta_static()` 里通过 `OnceLock` 一次性构造,
4//! 派发时不需要遍历 trait method 取元信息。
5
6use crate::action::action_trait::{Permission, PermissionMode};
7
8/// 单个 Action 的静态元信息聚合体。
9///
10/// 标注 `#[non_exhaustive]`:未来新增字段不构成破坏性变更。
11/// 请使用 [`ActionMeta::new`] 构造。
12#[non_exhaustive]
13pub struct ActionMeta {
14    /// Action 唯一标识,路由 dispatch 时用
15    pub name: &'static str,
16    /// 用户可见的显示名
17    pub display_name: &'static str,
18    /// 简介
19    pub description: &'static str,
20    /// 所需权限列表(dispatch 时检查)
21    pub permissions: &'static [Permission],
22    /// 权限匹配模式:All(AND)或 Any(OR)
23    pub permission_mode: PermissionMode,
24    /// 是否公开(true 则跳过权限/登录检查)
25    pub is_public: bool,
26    /// 入参 JSON Schema(OnceLock 生成)
27    pub input_schema: &'static schemars::schema::RootSchema,
28    /// 出参 JSON Schema
29    pub output_schema: &'static schemars::schema::RootSchema,
30}
31
32impl ActionMeta {
33    /// 构造 `ActionMeta`(`#[non_exhaustive]` 后的唯一公开构造入口)。
34    #[allow(clippy::too_many_arguments)]
35    pub const fn new(
36        name: &'static str,
37        display_name: &'static str,
38        description: &'static str,
39        permissions: &'static [Permission],
40        permission_mode: PermissionMode,
41        is_public: bool,
42        input_schema: &'static schemars::schema::RootSchema,
43        output_schema: &'static schemars::schema::RootSchema,
44    ) -> Self {
45        Self {
46            name,
47            display_name,
48            description,
49            permissions,
50            permission_mode,
51            is_public,
52            input_schema,
53            output_schema,
54        }
55    }
56}