bpi-rs 0.1.3

Bilibili API client library for Rust
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! 获取合集列表 API
//!
//! [参考文档](https://github.com/Yuelioi/bilibili-API-collect/tree/cfc5fddcc8a94b74d91970bb5b4eaeb349addc47/docs/creativecenter/season/list.md)

use crate::{ BilibiliRequest, BpiClient, BpiError, BpiResponse };
use serde::{ Deserialize, Serialize };

use super::models::{ Season, Section };

/// 合集列表返回结构
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SeasonListData {
    pub seasons: Vec<SeasonItem>,
    pub tip: serde_json::Value,
    pub total: u32,
    pub play_type: u32,
}

/// 单个合集条目
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SeasonItem {
    pub season: Season,
    pub course: Option<serde_json::Value>,
    pub checkin: Option<CheckInInfo>,
    #[serde(rename = "seasonStat")]
    pub season_stat: Option<SeasonStat>,
    pub sections: Option<SectionsWrapper>,
    pub part_episodes: Vec<PartEpisode>,
}

/// 合集审核信息
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CheckInInfo {
    pub status: i32,
    pub status_reason: Option<String>,
    pub season_status: i32,
}

/// 合集统计信息
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SeasonStat {
    pub view: u64,
    pub danmaku: u64,
    pub reply: u64,
    pub fav: u64,
    pub coin: u64,
    pub share: u64,
    #[serde(rename = "nowRank")]
    pub now_rank: u32,
    #[serde(rename = "hisRank")]
    pub his_rank: u32,
    pub like: u64,
    pub subscription: u64,
    pub vt: u32,
}

/// 小节包装器
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SectionsWrapper {
    pub sections: Vec<Section>,
}

/// 合集内视频条目
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PartEpisode {
    pub id: u64,
    pub title: String,
    pub aid: u64,
    pub bvid: String,
    pub cid: u64,
    #[serde(rename = "seasonId")]
    pub season_id: u64,
    #[serde(rename = "sectionId")]
    pub section_id: u64,
    pub order: u32,
    #[serde(rename = "videoTitle")]
    pub video_title: Option<String>,
    #[serde(rename = "archiveTitle")]
    pub archive_title: Option<String>,
    #[serde(rename = "archiveState")]
    pub archive_state: i32,
    #[serde(rename = "rejectReason")]
    pub reject_reason: Option<String>,
    pub state: i32,
    pub cover: String,
    pub is_free: i32,
    pub aid_owner: bool,
    #[serde(rename = "charging_pay")]
    pub charging_pay: u32,
}

impl BpiClient {
    /// 获取合集列表
    ///
    /// 获取当前用户创建的合集列表，支持分页和排序。
    ///
    /// # 参数
    /// | 名称 | 类型 | 说明 |
    /// | ---- | ---- | ---- |
    /// | `pn` | u32 | 页码，默认 1 |
    /// | `ps` | u32 | 每页数量，默认 30 |
    /// | `order` | `Option<&str>` | 排序方式：ctime 或 mtime |
    /// | `sort` | `Option<&str>` | 升降序：asc 或 desc |
    ///
    /// # 文档
    /// [获取合集列表](https://github.com/Yuelioi/bilibili-API-collect/tree/cfc5fddcc8a94b74d91970bb5b4eaeb349addc47/docs/creativecenter/season/list.md#获取合集列表)
    pub async fn season_list(
        &self,
        pn: u32,
        ps: u32,
        order: Option<&str>,
        sort: Option<&str>
    ) -> Result<BpiResponse<SeasonListData>, BpiError> {
        let mut query: Vec<(&str, String)> = vec![("pn", pn.to_string()), ("ps", ps.to_string())];

        if let Some(order_val) = order {
            query.push(("order", order_val.to_string()));
        }
        if let Some(sort_val) = sort {
            query.push(("sort", sort_val.to_string()));
        }

        self
            .get("https://member.bilibili.com/x2/creative/web/seasons")
            .query(&query)
            .send_bpi("获取合集列表").await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_season_list() -> Result<(), Box<BpiError>> {
        let bpi = BpiClient::new();
        let data = bpi.season_list(1, 10, Some("ctime"), Some("desc")).await?.into_data()?;

        tracing::info!("共 {} 个合集", data.total);
        for s in data.seasons {
            tracing::info!("合集: {} - {}", s.season.id, s.season.title);
        }

        Ok(())
    }
}