Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::validation::Max< Type > Class Template Referencefinal

Validate that value is not greater than max. More...

#include <Validators.hpp>

Public Member Functions

 Max (Type max)
 Construct the validator storing max value.
 
MaybeError verify (boost::json::value const &value, std::string_view key) const
 Verify that the JSON value is not greater than max.
 

Detailed Description

template<typename Type>
class rpc::validation::Max< Type >

Validate that value is not greater than max.

Constructor & Destructor Documentation

◆ Max()

template<typename Type >
rpc::validation::Max< Type >::Max ( Type max)
inlineexplicit

Construct the validator storing max value.

Parameters
max

Member Function Documentation

◆ verify()

template<typename Type >
MaybeError rpc::validation::Max< Type >::verify ( boost::json::value const & value,
std::string_view key ) const
inlinenodiscard

Verify that the JSON value is not greater than max.

Parameters
valueThe JSON value representing the outer object
keyThe key used to retrieve the tested value from the outer object
Returns
RippledError::rpcINVALID_PARAMS if validation failed; otherwise no error is returned

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