From c11e042fc2fe60294eb43860030162e3c64f2858 Mon Sep 17 00:00:00 2001 From: Kevin Pease Date: Wed, 5 Jun 2024 10:57:44 +0200 Subject: [PATCH] Add documentation --- stellar_rust_sdk/src/fee_stats/mod.rs | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/stellar_rust_sdk/src/fee_stats/mod.rs b/stellar_rust_sdk/src/fee_stats/mod.rs index 1bb60f7..9e96ab9 100644 --- a/stellar_rust_sdk/src/fee_stats/mod.rs +++ b/stellar_rust_sdk/src/fee_stats/mod.rs @@ -1,6 +1,29 @@ +/// Provides the `FeeStatsRequest`. +/// +/// This module provides the `FeeStatsRequest` struct, specifically designed for +/// constructing requests to query information about fee stats from the Horizon +/// server. It is tailored for use with the [`HorizonClient::get_fee_stats`](crate::horizon_client::HorizonClient::get_fee_stats) +/// method. +/// pub mod fee_stats_request; + +/// Provides the responses. +/// +/// This module defines structures representing the response from the Horizon API when querying +/// for fee stats. The structures are designed to deserialize the JSON response into Rust +/// objects, enabling straightforward access to various details of a single Stellar account. +/// +/// These structures are equipped with serialization capabilities to handle the JSON data from the +/// Horizon server and with getter methods for easy field access. +/// pub mod response; +/// The base path for fee stats related endpoints in the Horizon API. +/// +/// # Usage +/// This variable is intended to be used internally by the request-building logic +/// to ensure consistent and accurate path construction for fee stats related API calls. +/// static FEE_STATS_PATH: &str = "fee_stats"; pub mod prelude {