Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::VaultInfoHandler Class Reference

The vault_info command retrieves information about a vault, currency, shares etc. More...

#include <VaultInfo.hpp>

Inheritance diagram for rpc::VaultInfoHandler:
Collaboration diagram for rpc::VaultInfoHandler:

Classes

struct  Output
 A struct to hold the output data for the command. More...

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

 VaultInfoHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new VaultInfo object.
Result process (Input const &input, Context const &ctx) const
 Process the VaultInfo command.

Friends

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

Detailed Description

The vault_info command retrieves information about a vault, currency, shares etc.

Constructor & Destructor Documentation

◆ VaultInfoHandler()

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

Construct a new VaultInfo object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

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

Process the VaultInfo command.

Parameters
inputThe input data for the command
ctxThe context of the request
Returns
The result of the operation

◆ tag_invoke

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

Convert the Output to a JSON object.

Parameters
jvThe JSON object to convert to
outputThe output to convert

The documentation for this class was generated from the following files:
  • /__w/clio/clio/src/rpc/handlers/VaultInfo.hpp
  • /__w/clio/clio/src/rpc/handlers/VaultInfo.cpp