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
68
69
70
71
72
73
74
75
76
77
78
79
80

use crate::models::Request;

/// Represents the liquidity pool ID.
#[derive(Default, Clone)]
pub struct LiquidityPoolId(String);

/// Represents the absence of a liquidity pool ID.
#[derive(Default, Clone)]
pub struct NoLiquidityPoolId;

/// Represents a request to fetch details of a single liquidity pool from the Horizon API.
///
/// `SingleLiquidityPoolRequest` is a struct tailored to querying details of a specific liquidity pool
/// on the Horizon API. This struct is designed to be used in conjunction with the
/// [`HorizonClient::get_single_liquidity_pool`](crate::horizon_client::HorizonClient::get_single_liquidity_pool) method.
///
/// The struct matches the parameters necessary to construct a request for the
/// <a href="https://developers.stellar.org/api/horizon/resources/liquidity-pools/single/">Retrieve A Liquidity Pool endpoint</a>
/// of the Horizon API.
///
/// # Fields
/// Required:
/// * `liquidity_pool_id` - The liquidity pool's ID.
///
/// ## Usage
/// Instances of `SingleLiquidityPoolRequest` are created and configured using setter methods for each
/// parameter.
/// ```
/// # use stellar_rs::liquidity_pools::prelude::SingleLiquidityPoolRequest;
/// # use stellar_rs::models::Request;
/// let request = SingleLiquidityPoolRequest::new()
///     .set_liquidity_pool_id("000000006520216af66d20d63a58534d6cbdf28ba9f2a9c1e03f8d9a756bb7d988b29bca")
///     .unwrap();
/// // Use with HorizonClient::get_single_liquidity_pool
/// ```
///
#[derive(Default)]
pub struct SingleLiquidityPoolRequest<I> {
    /// The liquidity pool's ID.
    pub liquidity_pool_id: I,
}

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

    /// Sets the liquidity pool ID for the request.
    ///
    /// # Arguments
    /// * `liquidity_pool_id` - A `String` specifying the liquidity pool's ID.
    ///
    pub fn set_liquidity_pool_id(
        self,
        liquidity_pool_id: impl Into<String>,
    ) -> Result<SingleLiquidityPoolRequest<LiquidityPoolId>, String> {
        Ok(SingleLiquidityPoolRequest {
            liquidity_pool_id: LiquidityPoolId(liquidity_pool_id.into()),
        })
    }
}

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

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

    fn build_url(&self, base_url: &str) -> String {
        format!(
            "{}/{}/{}",
            base_url,
            super::LIQUIDITY_POOLS_PATH,
            self.get_query_parameters()
        )
    }
}