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

use derive_getters::Getters;
use serde::Deserialize;

use crate::models::prelude::*;

/// Represents the navigational links belonging to an effect from the Stellar Horizon API.
///
/// This struct includes links such as the operation (current effect), succeeds, and precedes,
/// providing quick navigation across operational sequence belonging to the effect.
///
#[derive(Debug, Deserialize, Clone, Getters)]
pub struct EffectLink {
    /// The link to the current operation of the effect.
    operation: Link,
    /// The link to the effect succeeding the current operation of the effect.
    succeeds: Link,
    /// The link to the effect preceding the current operation of the effect.
    precedes: Link,
}

/// Represents a single effect record in the Horizon API response.
///
/// This struct encapsulates detailed information about a single effect, including its ID,
/// account, effect type, timestamps, and other relevant data.
///
#[derive(Debug, Deserialize, Clone, Getters)]
pub struct Effect {
    /// Navigational links related to the operation of the effect.
    #[serde(rename = "_links")]
    pub links: EffectLink,
    /// The unique identifier of the account.
    pub id: String,
    /// A token used for paging through results.
    pub paging_token: String,
    /// The ID of the account related to the effect.
    pub account: String,
    /// The type of the effect.
    #[serde(rename = "type")]
    pub effect_type: String,
    /// The integer representation of the effect type.
    pub type_i: u32,
    /// The timestamp when the effect was created.
    pub created_at: String,
    /// The starting balance of the account, applicable for certain effect types.
    pub starting_balance: Option<String>,
    /// The type of the asset involved in the effect, if applicable.
    pub asset_type: Option<String>,
    /// The amount of the asset transacted in the effect, if applicable.
    pub amount: Option<String>,
}

/// Represents the response to a request for listing all effects from the Stellar Horizon API.
///
/// This struct contains the overall structure of the response for querying all effects. It includes
/// navigational links and a collection of effect records, each with comprehensive details about the effect.
///
#[derive(Debug, Deserialize, Clone, Getters)]
pub struct EffectsResponse {
    /// Navigational links for the current, next, and previous pages of the response.
    #[serde(rename = "_links")]
    links: ResponseLinks,
    /// Contains the actual list of effect records in the `records` field.

    #[serde(rename = "_embedded")]
    embedded: Embedded<Effect>,
}

impl Response for EffectsResponse {
    fn from_json(json: String) -> Result<EffectsResponse, String> {
        serde_json::from_str(&json).map_err(|e| e.to_string())
    }
}