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
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114

mod factions;

use std::num::NonZeroU64;

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

impl StClient {
    pub async fn register(
        &self,
        symbol: &str,
        faction: types::FactionSymbol,
    ) -> Result<types::RegisterResponse, ClientError> {
        self.register_with_priority(symbol, faction, RequestPriority::Normal)
            .await
    }

    pub async fn register_with_priority(
        &self,
        symbol: &str,
        faction: types::FactionSymbol,
        priority: RequestPriority,
    ) -> Result<types::RegisterResponse, ClientError> {
        let body = types::RegisterBody {
            symbol: symbol
                .parse()
                .map_err(|e| ClientError::Api(format!("invalid symbol: {e:?}")))?,
            faction,
        };
        self.send_mutating("register", priority, || self.inner.register(&body))
            .await
    }

    pub async fn my_agent(&self) -> Result<types::GetMyAgentResponse, ClientError> {
        self.my_agent_with_priority(RequestPriority::Normal).await
    }

    pub async fn my_agent_with_priority(
        &self,
        priority: RequestPriority,
    ) -> Result<types::GetMyAgentResponse, ClientError> {
        self.send("get_my_agent", priority, || self.inner.get_my_agent())
            .await
    }

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

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

    pub async fn get_agent(
        &self,
        agent_symbol: &str,
    ) -> Result<types::GetAgentResponse, ClientError> {
        self.get_agent_with_priority(agent_symbol, RequestPriority::Normal)
            .await
    }

    pub async fn get_agent_with_priority(
        &self,
        agent_symbol: &str,
        priority: RequestPriority,
    ) -> Result<types::GetAgentResponse, ClientError> {
        self.send("get_agent", priority, || self.inner.get_agent(agent_symbol))
            .await
    }

    pub async fn get_my_agent_events(
        &self,
    ) -> Result<types::GetMyAgentEventsResponse, ClientError> {
        self.get_my_agent_events_with_priority(RequestPriority::Normal)
            .await
    }

    pub async fn get_my_agent_events_with_priority(
        &self,
        priority: RequestPriority,
    ) -> Result<types::GetMyAgentEventsResponse, ClientError> {
        self.send("get_my_agent_events", priority, || {
            self.inner.get_my_agent_events()
        })
        .await
    }

    pub async fn get_my_account(&self) -> Result<types::GetMyAccountResponse, ClientError> {
        self.get_my_account_with_priority(RequestPriority::Normal)
            .await
    }

    pub async fn get_my_account_with_priority(
        &self,
        priority: RequestPriority,
    ) -> Result<types::GetMyAccountResponse, ClientError> {
        self.send("get_my_account", priority, || self.inner.get_my_account())
            .await
    }
}