topstats 0.1.0

Rust SDK for the TopStats.gg API - Discord bot statistics tracking
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

//! Shared endpoint logic and helper functions.
//!
//! This module contains validation functions and response types shared
//! between the async and blocking clients.

use crate::error::{Error, Result};
use crate::models::{Bot, RankedBot};

/// Validates a Discord bot ID format (17-19 digit snowflake).
pub fn validate_bot_id(id: u64) -> Result<()> {
    if Bot::validate_id(id) {
        Ok(())
    } else {
        Err(Error::InvalidBotId(id.to_string()))
    }
}

/// Validates a Discord user ID format (17-19 digit snowflake).
pub fn validate_user_id(id: u64) -> Result<()> {
    if Bot::validate_id(id) {
        Ok(())
    } else {
        Err(Error::InvalidUserId(id.to_string()))
    }
}

/// Response wrapper for tag search.
#[derive(serde::Deserialize)]
pub struct TagResponse {
    /// Tag data containing results.
    pub data: TagData,
}

/// Tag data containing bot results.
#[derive(serde::Deserialize)]
pub struct TagData {
    /// List of bots matching the tag.
    pub results: Vec<Bot>,
}

/// Response wrapper for bot comparison.
#[derive(serde::Deserialize)]
pub struct CompareResponse {
    /// List of compared bots.
    pub data: Vec<RankedBot>,
}

/// Builds query parameters for rankings requests.
#[must_use]
pub fn build_rankings_params(query: &crate::RankingsQuery) -> Vec<(&'static str, String)> {
    let mut params: Vec<(&str, String)> = vec![
        ("sortBy", query.sort_by.to_string()),
        ("sortMethod", query.sort_order.to_string()),
    ];

    if let Some(limit) = query.limit {
        params.push(("limit", limit.to_string()));
    }
    if let Some(offset) = query.offset {
        params.push(("offset", offset.to_string()));
    }

    params
}

/// Builds query parameters for search requests.
#[must_use]
pub fn build_search_params(
    query: &str,
    limit: Option<u32>,
    offset: Option<u32>,
    include_deleted: Option<bool>,
) -> Vec<(&'static str, String)> {
    let mut params: Vec<(&str, String)> = vec![("query", query.to_string())];

    if let Some(limit) = limit {
        params.push(("limit", limit.to_string()));
    }
    if let Some(offset) = offset {
        params.push(("offset", offset.to_string()));
    }
    if let Some(include_deleted) = include_deleted {
        params.push(("includeDeleted", include_deleted.to_string()));
    }

    params
}