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

use std::net::IpAddr;

use crate::{BpiError, BpiResult};

/// Parameters for `/ip_service/v1/ip_service/get_ip_addr`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct ClientInfoIpParams {
    ip: Option<IpAddr>,
}

impl ClientInfoIpParams {
    /// Creates parameters that query the caller's current IP address.
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates parameters for a validated IP address.
    pub fn for_ip(ip: IpAddr) -> Self {
        Self { ip: Some(ip) }
    }

    /// Parses and sets an IPv4 or IPv6 address.
    pub fn with_ip_str(mut self, ip: &str) -> BpiResult<Self> {
        self.ip = Some(parse_ip(ip)?);
        Ok(self)
    }

    pub(crate) fn query_pairs(&self) -> Vec<(&'static str, String)> {
        self.ip
            .map(|ip| vec![("ip", ip.to_string())])
            .unwrap_or_default()
    }
}

fn parse_ip(ip: &str) -> BpiResult<IpAddr> {
    ip.trim().parse().map_err(|_| {
        BpiError::invalid_parameter("ip", "value must be a valid IPv4 or IPv6 address")
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn client_info_ip_params_serializes_empty_defaults() {
        let params = ClientInfoIpParams::new();

        assert!(params.query_pairs().is_empty());
    }

    #[test]
    fn client_info_ip_params_serializes_ipv4() -> BpiResult<()> {
        let params = ClientInfoIpParams::new().with_ip_str("8.8.8.8")?;

        assert_eq!(params.query_pairs(), vec![("ip", "8.8.8.8".to_string())]);
        Ok(())
    }

    #[test]
    fn client_info_ip_params_serializes_ipv6() -> BpiResult<()> {
        let params = ClientInfoIpParams::new().with_ip_str("2001:4860:4860::8888")?;

        assert_eq!(
            params.query_pairs(),
            vec![("ip", "2001:4860:4860::8888".to_string())]
        );
        Ok(())
    }

    #[test]
    fn client_info_ip_params_rejects_invalid_ip() {
        let err = ClientInfoIpParams::new()
            .with_ip_str("not-an-ip")
            .unwrap_err();

        assert!(matches!(
            err,
            BpiError::InvalidParameter { field: "ip", .. }
        ));
    }
}