garrison 0.9.0

Garrison - 面向 Rust 生态的一站式身份认证鉴权框架
Documentation
// Copyright (c) 2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! `Annotation` / `AnnotationMode` 的 Display / FromStr / 内联方法实现。

use super::{Annotation, AnnotationMode};
use crate::error::GarrisonError;

impl std::fmt::Display for AnnotationMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            AnnotationMode::And => write!(f, "AND"),
            AnnotationMode::Or => write!(f, "OR"),
        }
    }
}

impl Annotation {
    /// 获取注解的字符串名称(用于 router 中间件配置与日志记录)。
    ///
    /// 携带数据的变体(`CheckPermission`、`CheckRole`、`CheckApiKey`、`Mode`)只返回裸名称,
    /// 无法经 `FromStr` 解析回原变体;如需序列化含数据变体,请使用 `serde`。
    ///
    /// # 示例
    ///
    /// ```
    /// use garrison::annotation::Annotation;
    ///
    /// // 无数据变体:name() 与 FromStr 双向一致
    /// let a = Annotation::CheckLogin;
    /// assert_eq!(a.name().parse::<Annotation>().unwrap(), a);
    ///
    /// // 含数据变体:name() 返回裸名称,FromStr 无法解析
    /// let p = Annotation::CheckPermission("read".into());
    /// assert_eq!(p.name(), "CheckPermission");
    /// assert!("CheckPermission".parse::<Annotation>().is_err());
    /// ```
    pub fn name(&self) -> &'static str {
        match self {
            Annotation::CheckLogin => "CheckLogin",
            Annotation::CheckPermission(_) => "CheckPermission",
            Annotation::CheckRole(_) => "CheckRole",
            Annotation::CheckSafe => "CheckSafe",
            Annotation::CheckDisable => "CheckDisable",
            Annotation::CheckOr => "CheckOr",
            Annotation::CheckAnd => "CheckAnd",
            Annotation::CheckNot => "CheckNot",
            Annotation::Ignore => "Ignore",
            Annotation::CheckBasicAuth => "CheckBasicAuth",
            Annotation::CheckDigestAuth => "CheckDigestAuth",
            Annotation::CheckSign => "CheckSign",
            Annotation::CheckApiKey { .. } => "CheckApiKey",
            Annotation::Mode(_) => "Mode",
            Annotation::CheckAccessToken => "CheckAccessToken",
            Annotation::CheckClientToken => "CheckClientToken",
        }
    }
}

impl std::fmt::Display for Annotation {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.name())
    }
}

impl std::str::FromStr for Annotation {
    type Err = GarrisonError;

    /// 从字符串解析注解:仅支持**无数据变体**的双向转换,
    /// 含数据变体(`CheckPermission`、`CheckRole`、`CheckApiKey`、`Mode`)需显式构造。
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "CheckLogin" => Ok(Annotation::CheckLogin),
            "CheckSafe" => Ok(Annotation::CheckSafe),
            "CheckDisable" => Ok(Annotation::CheckDisable),
            "CheckOr" => Ok(Annotation::CheckOr),
            "CheckAnd" => Ok(Annotation::CheckAnd),
            "CheckNot" => Ok(Annotation::CheckNot),
            "Ignore" => Ok(Annotation::Ignore),
            "CheckBasicAuth" => Ok(Annotation::CheckBasicAuth),
            "CheckDigestAuth" => Ok(Annotation::CheckDigestAuth),
            "CheckSign" => Ok(Annotation::CheckSign),
            "CheckAccessToken" => Ok(Annotation::CheckAccessToken),
            "CheckClientToken" => Ok(Annotation::CheckClientToken),
            _ => Err(GarrisonError::InvalidParam(format!(
                "annotation-parse-failed::{}",
                s
            ))),
        }
    }
}