twitch_highway 0.5.1

Twitch API
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

mod builder;
mod response;
mod types;

pub use builder::{CreateClip, GetClips};
pub use response::{ClipsDownloadResponse, ClipsInfoResponse, NewClipResponse};
pub use types::{Clip, ClipDownload, NewClip};

use builder::ClipSelect;

use std::future::Future;

use crate::{
    types::{
        constants::{BROADCASTER_ID, CLIPS, CLIP_ID, DOWNLOADS, EDITOR_ID, VIDEOS},
        BroadcasterId, ClipId, UserId,
    },
    Client, Error,
};

pub trait ClipsAPI {
    /// See <https://dev.twitch.tv/docs/api/reference/#create-clip>
    fn create_clip<'a>(&'a self, broadcaster_id: &'a BroadcasterId) -> CreateClip<'a>;

    /// - `&BroadcasterId`, `&GameId`, or `&[ClipId]` (slice, array, or Vec)
    ///
    /// See <https://dev.twitch.tv/docs/api/reference/#get-clips>
    fn get_clips<'a>(&'a self, select: impl Into<ClipSelect<'a>>) -> GetClips<'a>;

    /// See <https://dev.twitch.tv/docs/api/reference#get-clips-download>
    fn get_clips_download(
        &self,
        editor_id: &UserId,
        broadcaster_id: &BroadcasterId,
        clip_ids: &[ClipId],
    ) -> impl Future<Output = Result<ClipsDownloadResponse, Error>> + Send;

    /// See <https://dev.twitch.tv/docs/api/reference#create-clip-from-vod>
    fn create_clip_from_vod(
        &self,
        editor_id: &UserId,
        broadcaster_id: &BroadcasterId,
        vod_id: &str,
        vod_offset: u64,
        title: &str,
        duration: Option<f64>,
    ) -> impl Future<Output = Result<NewClipResponse, Error>> + Send;
}

impl ClipsAPI for Client {
    fn create_clip<'a>(&'a self, broadcaster_id: &'a BroadcasterId) -> CreateClip<'a> {
        CreateClip::new(self, broadcaster_id)
    }

    fn get_clips<'a>(&'a self, select: impl Into<ClipSelect<'a>>) -> GetClips<'a> {
        GetClips::new(self, select)
    }

    async fn get_clips_download(
        &self,
        editor_id: &UserId,
        broadcaster_id: &BroadcasterId,
        clip_ids: &[ClipId],
    ) -> Result<ClipsDownloadResponse, Error> {
        let mut url = self.base_url();

        url.path_segments_mut().unwrap().extend([CLIPS, DOWNLOADS]);

        url.query_pairs_mut()
            .append_pair(EDITOR_ID, editor_id)
            .append_pair(BROADCASTER_ID, broadcaster_id)
            .extend_pairs(clip_ids.iter().map(|id| (CLIP_ID, id)));

        self.json(self.http_client().get(url)).await
    }

    async fn create_clip_from_vod(
        &self,
        editor_id: &UserId,
        broadcaster_id: &BroadcasterId,
        vod_id: &str,
        vod_offset: u64,
        title: &str,
        duration: Option<f64>,
    ) -> Result<NewClipResponse, Error> {
        let mut url = self.base_url();

        url.path_segments_mut().unwrap().extend([VIDEOS, CLIPS]);

        url.query_pairs_mut()
            .append_pair(EDITOR_ID, editor_id)
            .append_pair(BROADCASTER_ID, broadcaster_id)
            .append_pair("vod_id", vod_id)
            .append_pair("vod_offset", &vod_offset.to_string())
            .append_pair("title", title);

        if let Some(duration) = duration {
            url.query_pairs_mut()
                .append_pair("duration", &format!("{:.1}", duration));
        }

        self.json(self.http_client().post(url)).await
    }
}