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

use crate::Getters;
use serde::{Deserialize, Serialize};

/// Represents the navigational links in a response.
///
/// Contains the links to the current, next, and previous pages of the response.
///
#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
pub struct ResponseLinks {
    #[serde(rename = "self")]
    pub self_link: Link,
    pub next: Option<Link>,
    pub prev: Option<Link>,
}

/// Represents a navigational link in a response.
///
/// Contains an optional url.
///
#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
pub struct Link {
    pub href: Option<String>,
}

/// Represents a navigational link in a response.
///
/// Contains an optional url, and an optional boolean to indicate whether a link is templated or not.
///
#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
pub struct TemplateLink {
    pub href: Option<String>,
    pub templated: Option<bool>,
}

/// Represents a collection of results in a response.
///
/// Contains a vector, which can hold any type of record returned by the API.
#[derive(Default, Debug, Deserialize, Serialize, Clone, Getters)]
pub struct Embedded<T> {
    pub records: Vec<T>,
}

/// Represents the authorization and control flags for an asset in the all assets response.
///
/// Details the various boolean flags that are
/// set for an asset, indicating specific permissions or restrictions. These flags define how the
/// asset is controlled and can be used within the Stellar network.
///
#[derive(Debug, Serialize, Deserialize, Clone, Getters)]
pub struct Flags {
    /// A `bool` indicating whether authorization is required for an account to hold
    ///   or transact with the asset. If `true`, the issuer must approve account holders.
    auth_required: bool,
    /// A `bool` indicating whether the issuer has the ability to revoke the asset.
    ///   If `true`, the issuer can freeze the asset in user accounts.
    auth_revocable: bool,
    /// A `bool` indicating whether the asset's authorization flags can be changed
    ///   after issuance. If `true`, the issuer cannot change the `auth_required` and `auth_revocable` flags.
    auth_immutable: bool,
    /// A `bool` indicating whether the asset supports the clawback operation.
    ///   If `true`, the issuer can claw back the asset from user accounts.
    auth_clawback_enabled: bool,
}