nekosbest 0.21.6

nekos.best API wrapper
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

#[cfg(feature = "blocking")]
use nb_blocking_util::blocking;

use crate::client::{Client, ClientConfig};
use crate::{
    strong_types::{STCategory, STNekosBestResponse, STNekosBestResponseSingle},
    NekosBestError, STNekosBestSearchQuery, BASE_URL,
};

/// Gets a single image, with a supplied client.
///
/// # Errors
/// Any errors that can happen, refer to [`NekosBestError`].
#[cfg_attr(feature = "blocking", blocking)]
pub async fn get_with_client<C: STCategory>(
    client: &Client,
) -> Result<STNekosBestResponseSingle<C>, NekosBestError> {
    let r = crate::prepare_request(client.client.get(format!("{BASE_URL}/{}", C::CATEGORY)))
        .send()
        .await?;

    let mut resp = r
        .error_for_status()?
        .json::<STNekosBestResponse<C>>()
        .await?;
    let resp = resp.0.pop().ok_or(NekosBestError::NotFound)?;

    Ok(resp)
}

/// Gets `amount` images, with a supplied client.
/// Note that the server clamps the amount to the 1..=20 range
///
/// # Errors
/// Any errors that can happen, refer to [`NekosBestError`].
#[cfg_attr(feature = "blocking", blocking)]
pub async fn get_with_client_amount<C: STCategory>(
    client: &Client,
    amount: impl Into<u8>,
) -> Result<STNekosBestResponse<C>, NekosBestError> {
    let req = crate::prepare_request(client.client.get(format!("{BASE_URL}/{}", C::CATEGORY)))
        .query(&[("amount", amount.into())]);

    let r = req.send().await?;

    let v = r.error_for_status()?.json().await?;

    Ok(v)
}

/// Gets a single image, with the default client.
///
/// # Errors
/// Any errors that can happen, refer to [`NekosBestError`].
#[cfg_attr(feature = "blocking", blocking)]
pub async fn get<C: STCategory>() -> Result<STNekosBestResponseSingle<C>, NekosBestError> {
    get_with_client(&Client::new(ClientConfig::default())).await
}

/// Gets `amount` images, with the default client.
///
/// # Errors
/// Any errors that can happen, refer to [`NekosBestError`].
#[cfg_attr(feature = "blocking", blocking)]
pub async fn get_amount<C: STCategory>(
    amount: impl Into<u8>,
) -> Result<STNekosBestResponse<C>, NekosBestError> {
    get_with_client_amount(&Client::new(ClientConfig::default()), amount).await
}

#[cfg_attr(feature = "blocking", blocking)]
pub async fn search_with_client<C: STCategory>(
    client: &Client,
    query: STNekosBestSearchQuery<C>,
) -> Result<STNekosBestResponse<C>, NekosBestError> {
    #[cfg(not(feature = "blocking"))]
    client.handle_search_ratelimit().await?;

    let req = crate::prepare_request(client.client.get(format!("{BASE_URL}/search")));

    let req = query.apply_to(req);

    let res = req.send().await?;

    #[cfg(not(feature = "blocking"))]
    client.update_search_ratelimit_data(res.headers()).await;

    Ok(res.error_for_status()?.json().await?)
}

#[deprecated(
    note = "Use `search_with_client` instead, and provide a client.",
    since = "0.17.0"
)]
#[cfg_attr(feature = "blocking", blocking)]
pub async fn search<C: STCategory>(
    query: STNekosBestSearchQuery<C>,
) -> Result<STNekosBestResponse<C>, NekosBestError> {
    search_with_client(&Client::new(ClientConfig::default()), query).await
}