stellar-rs 1.0.0

A Rust SDK for the Stellar network.
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

use crate::models::*;
use stellar_rust_sdk_derive::pagination;

/// Represents the ID of an offer for which the trades are to be retrieved.
#[derive(Default, Clone)]
pub struct TradeOfferId(String);

/// Represents the absence of an ID of an offer for which the trades are to be retrieved.
#[derive(Default, Clone)]
pub struct NoTradeOfferId;

#[pagination]
#[derive(Default)]
pub struct TradesForOfferRequest<I> {
    /// The ID of the offer for which the trades are to be retrieved.
    offer_id: I,
}

impl TradesForOfferRequest<TradeOfferId> {
    /// Creates a new `TradesForOfferRequest` with default parameters.
    pub fn new() -> Self {
        TradesForOfferRequest::default()
    }

    /// Sets the offer ID for the request.
    ///
    /// # Arguments
    /// * `offer_id` - The offer ID for which the trades are to be retrieved.
    ///
    /// # Returns
    /// A `TradesForOfferRequest` with the specified offer ID, or an error if the offer ID is invalid.
    ///
    pub fn set_offer_id(
        self,
        offer_id: impl Into<String>,
    ) -> Result<TradesForOfferRequest<TradeOfferId>, String> {
        Ok(TradesForOfferRequest {
            offer_id: TradeOfferId(offer_id.into()),
            cursor: self.cursor,
            limit: self.limit,
            order: self.order,
        })
    }
}

impl Request for TradesForOfferRequest<TradeOfferId> {
    fn get_query_parameters(&self) -> String {
        let mut query = String::new();
        query.push_str(&format!("{}", self.offer_id.0));

        query.trim_end_matches('&').to_string()
    }

    fn build_url(&self, base_url: &str) -> String {
        // This URL is not built with query paramaters, but with the offer's ID as addition to the path.
        // Therefore there is no `?` but a `/` in the formatted string.
        // Additionally, this request uses the API endpoint for `offers`.
        use crate::offers::OFFERS_PATH;
        format!(
            "{}/{}/{}/{}",
            base_url,
            OFFERS_PATH,
            self.get_query_parameters(),
            super::TRADES_PATH
        )
    }
}