rsmycqu 0.4.3

A Rust library for interacting with Chonqing University services, including SSO authentication, campus card management, and more.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! [`errors`]模块提供了[`rsmycqu`]的所有错误定义

use snafu::Snafu;

use crate::errors::sealed::Sealed;

pub mod session;

#[cfg(feature = "sso")]
pub mod sso;

#[cfg(feature = "mycqu")]
pub mod mycqu;

#[cfg(feature = "card")]
pub mod card;

mod sealed {
    use crate::errors::sso;

    pub trait Sealed {}

    #[cfg(feature = "sso")]
    impl Sealed for sso::SSOError {}

    #[cfg(feature = "mycqu")]
    impl Sealed for crate::errors::mycqu::MyCQUError {}

    #[cfg(feature = "card")]
    impl Sealed for crate::errors::card::CardError {}
}

/// RsMyCQUError
pub trait RsMyCQUError: std::error::Error + 'static + Sealed {}

/// 错误类型
#[derive(Debug, Snafu)]
#[snafu(visibility(pub(crate)))]
pub enum ApiError<T: RsMyCQUError> {
    /// 当用户未登陆时抛出
    #[snafu(display("Request Before Login"))]
    NotLogin,

    /// 当用户未获取相应服务访问权限时抛出
    #[snafu(display("Request Before Get Access"))]
    NotAccess,

    /// 当Session构造失败时抛出
    #[snafu(display("Session Error: {source}"))]
    Session {
        /// Session错误
        source: session::SessionError,
    },

    /// 当使用[reqwest]发起的请求失败时抛出
    #[snafu(display("Reqwest Error: {source}"))]
    Request {
        /// [reqwest]抛出的错误[reqwest::Error]
        source: reqwest::Error,
    },

    /// 数据模型解析异常时抛出
    #[snafu(display("Model Parse Error: {msg}; Raw Response: {raw_response}"))]
    ModelParse {
        /// 错误信息
        msg: String,
        /// 原始请求响应
        raw_response: String,
    },

    /// 当请求网站出现异常时抛出
    #[snafu(display("Request Website Error: {msg}"))]
    Website {
        /// 错误详细信息
        msg: String,
    },

    /// 内部错误
    #[snafu(transparent)]
    Inner {
        /// 内部错误
        source: T,
    },

    /// 未知错误
    #[snafu(whatever)]
    Whatever {
        /// 错误信息
        message: String,
        /// 错误来源
        #[snafu(source(from(Box<dyn std::error::Error + Send + Sync>, Some)))]
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },
}

#[allow(private_bounds)]
impl<T: RsMyCQUError> ApiError<T> {
    pub(crate) fn location_error() -> Self {
        ApiError::Website {
            msg: "Expected response has \"Location\" but not found".to_string(),
        }
    }
}

impl<T: RsMyCQUError> From<reqwest::Error> for ApiError<T> {
    fn from(source: reqwest::Error) -> Self {
        ApiError::Request { source }
    }
}

impl<T: RsMyCQUError> From<session::SessionError> for ApiError<T> {
    fn from(source: session::SessionError) -> Self {
        ApiError::Session { source }
    }
}

/// API返回结果
pub type ApiResult<T, E> = Result<T, ApiError<E>>;