Skip to content

Commit dd6729a

Browse files
committed
Add documentation
1 parent b230149 commit dd6729a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

stellar_rust_sdk/src/ledgers/response.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ use stellar_xdr::curr::{LedgerHeader, Limits, ReadXdr};
44

55
use crate::models::prelude::*;
66

7+
/// Represents the navigational links in a single ledger response from the Horizon API.
8+
///
9+
/// This struct includes various hyperlinks such as links to the ledger itself,
10+
/// transactions, operations, payments and effects
11+
///
712
#[derive(Debug, Deserialize, Clone, Getters)]
813
pub struct LedgerLinks {
914
#[serde(rename = "self")]
@@ -14,6 +19,12 @@ pub struct LedgerLinks {
1419
pub effects: TemplateLink,
1520
}
1621

22+
/// Represents the response for a single ledger query in the Horizon API.
23+
///
24+
/// This struct defines the overall structure of the response for a ledger offer query.
25+
/// It includes navigational links, offer identifiers, the ID, the hash, the sequence number,
26+
/// and additional data
27+
///
1728
#[derive(Debug, Deserialize, Clone, Getters)]
1829
pub struct Ledger {
1930
/// Navigational links related to the ledger.

0 commit comments

Comments
 (0)