altstream-api 0.1.0

Rust API wrapper for the alternative streaming platform AltStream Online
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


use std::error::Error;

use crate::{pub_transmission_types::*, request::*};

const BASE: &str = "https://altstream.online/api/v1";

/// Get information about a channel.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let channel_info = altstream_api::get_channel_info("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_channel_info(username: &str) -> Result<ChannelInfo, Box<dyn Error>> {
    parse_unwrap_response(&request(&format!("{BASE}/channels/{username}")).await?)
}

/// Get information about a channel's panels.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let panels = altstream_api::get_channel_panels("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_channel_panels(username: &str) -> Result<Panels, Box<dyn Error>> {
    parse_unwrap_response(&request(&format!("{BASE}/channels/{username}/panels")).await?)
}

/// Get information about a channel's rewards.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let rewards = altstream_api::get_channel_rewards("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_channel_rewards(username: &str) -> Result<ChannelRewards, Box<dyn Error>> {
    parse_unwrap_response(&request(&format!("{BASE}/channels/{username}/rewards")).await?)
}

/// Get information about a channel's emotes.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let emotes = altstream_api::get_channel_emotes("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_channel_emotes(username: &str) -> Result<ChannelEmotes, Box<dyn Error>> {
    parse_unwrap_response(&request(&format!("{BASE}/channels/{username}/emotes")).await?)
}

/// Get information about a stream's tags.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tags = altstream_api::get_stream_tags("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_stream_tags(username: &str) -> Result<StreamTags, Box<dyn Error>> {
    parse_unwrap_response(&request(&format!("{BASE}/channels/{username}/tags")).await?)
}

/// Get information about a user's settings.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let settings = altstream_api::get_user_settings("letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_user_settings(username: &str) -> Result<UserSettings, Box<dyn Error>> {
    // user settings is the only endpoint that doesn't return a wrapped response,
    // so we use parse_response instead of parse_unwrap_response
    parse_response(&request(&format!("{BASE}/user-settings/{username}")).await?)
}

/// Get information about a user's settings for a specific channel.
///
/// # Example
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let settings = altstream_api::get_user_channel_settings("soweliluna", "letsgoashe").await?;
/// # Ok(())
/// # }
/// ```
///
/// See [AltStream Online API documentation](https://altstream.online/documentation?tab=api).
pub async fn get_user_channel_settings(
    username: &str,
    channel: &str,
) -> Result<UserSettings, Box<dyn Error>> {
    parse_response(
        &request(&format!(
            "{BASE}/user-settings/{username}?channel={channel}"
        ))
        .await?,
    )
}