bpi-rs 0.2.0

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

use super::info::FavFolderInfo;
use crate::BilibiliRequest;
use crate::fav::FavClient;
use crate::fav::params::{
    FavFolderAddParams, FavFolderDeleteParams, FavFolderEditParams, FavResourceBatchDeleteParams,
    FavResourceCleanParams, FavResourceTransferParams,
};
use crate::response::BpiResult;

const FOLDER_ADD_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/folder/add";
const FOLDER_EDIT_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/folder/edit";
const FOLDER_DEL_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/folder/del";
const RESOURCE_COPY_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/resource/copy";
const RESOURCE_MOVE_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/resource/move";
const RESOURCE_BATCH_DEL_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/resource/batch-del";
const RESOURCE_CLEAN_ENDPOINT: &str = "https://api.bilibili.com/x/v3/fav/resource/clean";

impl<'a> FavClient<'a> {
    /// Creates a favorite folder and returns the canonical payload result.
    pub async fn add_folder(&self, params: FavFolderAddParams) -> BpiResult<FavFolderInfo> {
        let csrf = self.client.csrf()?;
        self.client
            .post(FOLDER_ADD_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.folder.add")
            .await
    }

    /// Edits a favorite folder and returns the canonical payload result.
    pub async fn edit_folder(&self, params: FavFolderEditParams) -> BpiResult<FavFolderInfo> {
        let csrf = self.client.csrf()?;
        self.client
            .post(FOLDER_EDIT_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.folder.edit")
            .await
    }

    /// Deletes favorite folders and returns the canonical payload result.
    pub async fn delete_folders(&self, params: FavFolderDeleteParams) -> BpiResult<i32> {
        let csrf = self.client.csrf()?;
        self.client
            .post(FOLDER_DEL_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.folder.delete")
            .await
    }

    /// Copies favorite resources and returns the canonical payload result.
    pub async fn copy_resources(&self, params: FavResourceTransferParams) -> BpiResult<i32> {
        let csrf = self.client.csrf()?;
        self.client
            .post(RESOURCE_COPY_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.resource.copy")
            .await
    }

    /// Moves favorite resources and returns the canonical payload result.
    pub async fn move_resources(&self, params: FavResourceTransferParams) -> BpiResult<i32> {
        let csrf = self.client.csrf()?;
        self.client
            .post(RESOURCE_MOVE_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.resource.move")
            .await
    }

    /// Deletes favorite resources and returns the canonical payload result.
    pub async fn delete_resources(&self, params: FavResourceBatchDeleteParams) -> BpiResult<i32> {
        let csrf = self.client.csrf()?;
        self.client
            .post(RESOURCE_BATCH_DEL_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.resource.batch_delete")
            .await
    }

    /// Cleans invalid favorite resources and returns the canonical payload result.
    pub async fn clean_resources(&self, params: FavResourceCleanParams) -> BpiResult<i32> {
        let csrf = self.client.csrf()?;

        self.client
            .post(RESOURCE_CLEAN_ENDPOINT)
            .form(&params.form_pairs(&csrf))
            .send_bpi_payload("fav.resource.clean")
            .await
    }
}

#[cfg(test)]
mod tests {}