garrison 0.9.0

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

//! 预导出模块,包含最常用的类型与 trait。
//!
//! 通过 `use garrison::prelude::*;` 快速引入框架核心类型。

/// 全局配置结构体([GarrisonConfig])。
pub use crate::config::GarrisonConfig;
/// 请求标识传播载体与运行时助手(统一错误模型):中间件读取入口(`current` / `scope`)、传播助手与头名常量(`inject_request_id_into_error_body` 为 warp 内部回填机制,不进 prelude)。
pub use crate::context::request_id::{
    current, is_valid_inbound_request_id, propagate_or_generate, scope, RequestId, MAX_INBOUND_LEN,
    REQUEST_ID_HEADER, RETRY_AFTER_HEADER,
};
/// 上下文类型:请求/响应/存储抽象([GarrisonContext]、[GarrisonRequest]、[GarrisonResponse]、[GarrisonStorage])。
pub use crate::context::{GarrisonContext, GarrisonRequest, GarrisonResponse, GarrisonStorage};
/// 鉴权决策与请求模型([Decision]、[DecisionReason]、[AuthRequest])。
pub use crate::core::permission::{AuthRequest, Decision, DecisionReason};
/// DAO trait,持久化数据访问抽象([GarrisonDao])。
pub use crate::dao::GarrisonDao;
/// 错误类型与 Result 别名([GarrisonError]、[GarrisonResult])。
pub use crate::error::{GarrisonError, GarrisonResult};
/// 全局管理器单例([GarrisonManager])。
pub use crate::manager::GarrisonManager;
/// 插件 trait,编译期注册扩展点([GarrisonPlugin])。
pub use crate::plugin::GarrisonPlugin;
/// 路由器与拦截器抽象([GarrisonRouter]、[GarrisonInterceptor])。
pub use crate::router::{GarrisonInterceptor, GarrisonRouter};
/// 会话模型([GarrisonSession])。
pub use crate::session::GarrisonSession;
/// 逻辑层抽象与静态入口([GarrisonInterface]、[GarrisonLogicDefault]、[GarrisonUtil] + 5 个子 trait)。
pub use crate::stp::{
    GarrisonCore, GarrisonInterface, GarrisonLogicDefault, GarrisonUtil, MfaLogic, PasswordLogic,
    PermissionLogic, SessionLogic, TokenLogic,
};
/// 防火墙策略([GarrisonPermissionStrategy]、[GarrisonPermissionStrategyDefault])。
pub use crate::strategy::{GarrisonPermissionStrategy, GarrisonPermissionStrategyDefault};

/// 注解驱动的路由保护声明([Annotation],`GarrisonRouter::route_protected` 使用)。
pub use crate::annotation::Annotation;
/// 内置缓存 DAO(feature: cache-memory / cache-redis)。
#[cfg(any(feature = "cache-memory", feature = "cache-redis"))]
pub use crate::dao::GarrisonDaoOxcache;
/// 登录参数([LoginParams],`login` / `login_with_password` 使用)。
pub use crate::stp::LoginParams;
/// 请求上下文工具:设置当前 token 作用域 / 读取当前 token。
pub use crate::stp::{current_token, with_current_token};

/// 邀请码定向注册协议类型(feature: protocol-invitation)。
#[cfg(feature = "protocol-invitation")]
pub use crate::protocol::invitation::{
    InvitationHandler, InvitationInvalidReason, InvitationRecord, InvitationRedeemHook,
    InvitationSpec, InvitationStatus, InvitationStatusReport,
};

#[cfg(all(feature = "credit-metering", feature = "listener"))]
pub use crate::credit::CreditMeteringListener;
#[cfg(feature = "credit-metering")]
pub use crate::credit::{
    CreditAlertConfig, CreditConfig, CreditConsumeResult, CreditConsumptionRecord, CreditCycle,
    CreditError, CreditMeter, CreditMeterStorage, CreditMetrics, CreditResult, CreditSchedule,
    CreditUsage,
};