twitch_highway 0.3.0

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

mod builder;
mod response;
mod types;

pub use builder::{SearchCategoriesBuilder, SearchChannelsBuilder};
pub use response::{CategoriesResponse, ChannelsResponse};
pub use types::Channel;

use crate::TwitchAPI;

pub trait SearchAPI {
    /// Gets the games or categories that match the specified query
    ///
    /// # Arguments
    ///
    /// * `query` - The URI-encoded search string.
    ///
    /// # Returns
    ///
    /// Returns a [`SearchCategoriesBuilder`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::search::SearchAPI;
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .search_categories("%23archery")
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#search-categories>
    fn search_categories<'a>(&'a self, query: &'a str) -> SearchCategoriesBuilder<'a>;

    /// Gets the channels that match the specified query and have streamed content within the past 6 months
    ///
    /// # Arguments
    ///
    /// * `query` - The URI-encoded search string.
    ///
    /// # Returns
    ///
    /// Returns a [`SearchChannelsBuilder`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::search::SearchAPI;
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .search_channels("%20death")
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#search-channels>
    fn search_channels<'a>(&'a self, query: &'a str) -> SearchChannelsBuilder<'a>;
}

impl SearchAPI for TwitchAPI {
    fn search_categories<'a>(&'a self, query: &'a str) -> SearchCategoriesBuilder<'a> {
        SearchCategoriesBuilder::new(self, query)
    }
    fn search_channels<'a>(&'a self, query: &'a str) -> SearchChannelsBuilder<'a> {
        SearchChannelsBuilder::new(self, query)
    }
}