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

Validate that value is equal or greater than the specified min. More...

#include <Validators.hpp>

Public Member Functions

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

Detailed Description

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

Validate that value is equal or greater than the specified min.

Constructor & Destructor Documentation

◆ Min()

template<typename Type >
rpc::validation::Min< Type >::Min ( Type min)
inlineexplicit

Construct the validator storing min value.

Parameters
min

Member Function Documentation

◆ verify()

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

Verify that the JSON value is not smaller than min.

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: