Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-pease authored and LeonardTibben committed Jun 14, 2024
1 parent 7112430 commit c347642
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions stellar_rust_sdk/src/ledgers/response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ use stellar_xdr::curr::{LedgerHeader, Limits, ReadXdr};

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

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

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

0 comments on commit c347642

Please sign in to comment.