The concept for option validators passed to add_option/positional_option. More...
#include <seqan3/argument_parser/validators.hpp>
Related Functions | |
(Note that these are not member functions.) | |
Requirements for seqan3::validator | |
You can expect these (meta-)functions on all types that implement seqan3::validator. | |
using | option_value_type |
The type of value on which the validator is called on. More... | |
void | operator() (option_value_type const &cmp) const |
Validates the value 'cmp' and throws a seqan3::validation_error on failure. More... | |
std::string | get_help_page_message () const |
Returns a message that can be appended to the (positional) options help page info. More... | |
The concept for option validators passed to add_option/positional_option.
The requirements for this concept are given as related functions and type traits. Types that satisfy this concept are shown as "implementing this interface".
|
related |
Returns a message that can be appended to the (positional) options help page info.
Implemented in seqan3::regex_validator, seqan3::output_directory_validator, seqan3::input_directory_validator, seqan3::output_file_validator< file_t >, seqan3::input_file_validator< file_t >, seqan3::value_list_validator< option_value_t >, and seqan3::arithmetic_range_validator.
|
related |
Validates the value 'cmp' and throws a seqan3::validation_error on failure.
option_value_type | The type of the value to be validated. |
[in,out] | cmp | The value to be validated. |
seqan3::validation_error | if value 'cmp' does not pass validation. |
|
related |
The type of value on which the validator is called on.