ip-api4rs 3.0.0

A Rust library for the ip-api.com 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

//! A module that helps you building the correct url for a request.

use serde::Deserialize;
use serde_aux::prelude::serde_introspect;

/// Builds the url for a request.
/// The fields are automatically extracted from the struct.
///
/// # Arguments
/// * `https` - A `bool` indicating whether the url should be built for a HTTPS request or not.
/// * `ip` - The IP address to query for.
///
/// # Returns
/// A `String` containing the url for the request.
pub fn build_url_from_struct<'de, T>(https: bool, ip: &String) -> String
where
    T: Deserialize<'de>,
{
    let fields = serde_introspect::<T>();
    build_url_with_fields(https, ip, fields)
}

/// Builds the HTTP url for a request.
/// The fields are automatically extracted from the struct.
///
/// # Arguments
/// * `ip` - The IP address to query for.
///
/// # Returns
/// A `String` containing the url for the request.
pub fn build_http_url_from_struct<'de, T>(ip: &String) -> String
where
    T: Deserialize<'de>,
{
    let fields = serde_introspect::<T>();
    build_url_with_fields(false, ip, fields)
}

/// Builds the HTTPS url for a request.
/// The fields are automatically extracted from the struct.
///
/// # Arguments
/// * `ip` - The IP address to query for.
///
/// # Returns
/// A `String` containing the url for the request.
pub fn build_https_url_from_struct<'de, T>(ip: &String) -> String
where
    T: Deserialize<'de>,
{
    let fields = serde_introspect::<T>();
    build_url_with_fields(true, ip, fields)
}

/// Builds the url for a request without fields.
/// # Arguments
/// * `https` - A `bool` indicating whether the url should be built for a HTTPS request or not.
/// * `ip` - The IP address to query for.
///
/// # Returns
/// A `String` containing the url for the request.
pub fn build_url_without_fields(https: bool, ip: &String) -> String {
    match https {
        true => format!("{}{}", crate::constant::HTTPS_HOST, ip),
        false => format!("{}{}", crate::constant::HTTP_HOST, ip),
    }
}

/// Builds the url for a request with fields.
/// # Arguments
/// * `https` - A `bool` indicating whether the url should be built for a HTTPS request or not.
/// * `ip` - The IP address to query for.
///
/// # Returns
/// A `String` containing the url for the request.
pub fn build_url_with_fields(https: bool, ip: &String, fields: &[&'static str]) -> String {
    let mut fields_str = fields.join(",");
    if !fields.contains(&"message") {
        //We do this to get the error message if an error occurs.
        fields_str = fields.join(",") + ",message";
    }
    match https {
        true => format!("{}{}?fields={}", crate::constant::HTTPS_HOST, ip, fields_str),
        false => format!("{}{}?fields={}", crate::constant::HTTP_HOST, ip, fields_str),
    }
}