rpc::LedgerDataHandler Class Reference

The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version. More...

#include <LedgerData.hpp>

Inheritance diagram for rpc::LedgerDataHandler:

Collaboration diagram for rpc::LedgerDataHandler:

Classes
struct	Output
	A struct to hold the output data of the command. More...

Public Types
using	Result = HandlerReturnType<Output>

Public Member Functions
	LedgerDataHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
	Construct a new LedgerDataHandler object.
Result	process (Input const &input, Context const &ctx) const
	Process the LedgerData command.

Static Public Attributes
static constexpr auto	kLimitBinary = rpc::spec::handlers::ledger_data::kLimitBinary
static constexpr auto	kLimitJson = rpc::spec::handlers::ledger_data::kLimitJson

Friends
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, LedgerDataHandler::Output const &output)
	Convert the Output to a JSON object.

Detailed Description

The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.

For more details see: https://xrpl.org/ledger_data.html

Constructor & Destructor Documentation

LedgerDataHandler()

rpc::LedgerDataHandler::LedgerDataHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend )

inline

Construct a new LedgerDataHandler object.

Parameters

sharedPtrBackend

The backend to use

Member Function Documentation

process()

LedgerDataHandler::Result rpc::LedgerDataHandler::process ( Input const & input, Context const & ctx ) const

nodiscard

Process the LedgerData command.

Parameters

input	The input data for the command
ctx	The context of the request

Returns

The result of the operation

Friends And Related Symbol Documentation

tag_invoke

void tag_invoke ( boost::json::value_from_tag , boost::json::value & jv, LedgerDataHandler::Output const & output )

friend

Convert the Output to a JSON object.

Parameters

[out]	jv	The JSON object to convert to
	output	The output to convert

---

The documentation for this class was generated from the following files:

• /__w/clio/clio/src/rpc/handlers/LedgerData.hpp
• /__w/clio/clio/src/rpc/handlers/LedgerData.cpp