spacetraders-client 0.1.0

Async Rust client for the SpaceTraders API v2 with priority-aware rate limiting and retry
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

use std::num::NonZeroU64;

use crate::client::StClient;
use crate::client::{ClientError, RequestPriority};
use crate::types;

impl StClient {
    pub async fn get_factions(
        &self,
        limit: Option<NonZeroU64>,
        page: Option<NonZeroU64>,
    ) -> Result<types::GetFactionsResponse, ClientError> {
        self.get_factions_with_priority(limit, page, RequestPriority::Normal)
            .await
    }

    pub async fn get_factions_with_priority(
        &self,
        limit: Option<NonZeroU64>,
        page: Option<NonZeroU64>,
        priority: RequestPriority,
    ) -> Result<types::GetFactionsResponse, ClientError> {
        self.send("get_factions", priority, || {
            self.inner.get_factions(limit, page)
        })
        .await
    }

    pub async fn get_faction(
        &self,
        faction_symbol: &str,
    ) -> Result<types::GetFactionResponse, ClientError> {
        self.get_faction_with_priority(faction_symbol, RequestPriority::Normal)
            .await
    }

    pub async fn get_faction_with_priority(
        &self,
        faction_symbol: &str,
        priority: RequestPriority,
    ) -> Result<types::GetFactionResponse, ClientError> {
        self.send("get_faction", priority, || {
            self.inner.get_faction(faction_symbol)
        })
        .await
    }

    pub async fn get_my_factions(
        &self,
        limit: Option<NonZeroU64>,
        page: Option<NonZeroU64>,
    ) -> Result<types::GetMyFactionsResponse, ClientError> {
        self.get_my_factions_with_priority(limit, page, RequestPriority::Normal)
            .await
    }

    pub async fn get_my_factions_with_priority(
        &self,
        limit: Option<NonZeroU64>,
        page: Option<NonZeroU64>,
        priority: RequestPriority,
    ) -> Result<types::GetMyFactionsResponse, ClientError> {
        self.send("get_my_factions", priority, || {
            self.inner.get_my_factions(limit, page)
        })
        .await
    }
}