Skip to main content

yang_base/definition/
param.rs

1//! Action Params 的原生定义集合。
2
3use super::{FieldName, FieldRef, IntoFieldSpec, ParamSource, ParamSpec};
4
5/// 有序参数集合;每个参数明确标注 body/query/path/header 来源。
6#[derive(Debug, Clone, PartialEq, Eq, Default)]
7pub struct Params(Vec<ParamSpec>);
8
9/// 由 `params!` 生成的强类型输入契约。
10pub trait ParamInput {
11    /// 返回同一声明生成的静态参数定义。
12    fn params() -> Params;
13
14    /// 从传输请求按 ParamSpec 来源一次性构造强类型输入。
15    ///
16    /// 手写实现默认沿用单 body 反序列化;`params!` 会覆盖本方法并合并
17    /// body/query/path/header 后只执行一次结构体反序列化。
18    fn decode(request: &mut crate::action::Request) -> Result<Self, crate::error::BaseError>
19    where
20        Self: serde::de::DeserializeOwned + Sized,
21    {
22        serde_json::from_value(std::mem::take(&mut request.body)).map_err(|error| {
23            crate::error::BaseError::ParamInvalid("input".into(), error.to_string())
24        })
25    }
26}
27
28impl Params {
29    /// 创建空参数集合。
30    pub const fn new() -> Self {
31        Self(Vec::new())
32    }
33
34    /// 从类型化字段 Builder 创建 Action 专属参数定义。
35    pub fn param<B>(mut self, name: FieldName, source: ParamSource, builder: B) -> Self
36    where
37        B: IntoFieldSpec,
38    {
39        let field = builder.into_field_spec(name.clone());
40        self.0.push(ParamSpec::from_spec(name, source, field));
41        self
42    }
43
44    /// 复用 Module 字段的共享语义;引用在 AppBuilder::build 时解析。
45    pub fn from_field(mut self, name: FieldName, source: ParamSource, field: FieldRef) -> Self {
46        self.0.push(ParamSpec::new(name, source).from_field(field));
47        self
48    }
49
50    /// 返回参数定义。
51    pub fn as_slice(&self) -> &[ParamSpec] {
52        &self.0
53    }
54
55    pub(crate) fn into_vec(self) -> Vec<ParamSpec> {
56        self.0
57    }
58}