SeqAn3
The Modern C++ library for sequence analysis.
seqan3::validator Interface Reference

The concept for option validators passed to add_option/positional_option. More...

#include <seqan3/argument_parser/validators.hpp>

+ Inheritance diagram for seqan3::validator:

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 value_type
 The type of value on which the validator is called on. More...
 
void operator() (value_type const &cmp) const
 Validates the value 'cmp' and throws a seqan3::validation_failed 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...
 

Detailed Description

The concept for option validators passed to add_option/positional_option.

Concepts and doxygen

The requirements for this concept are given as related functions and type traits. Types that satisfy this concept are shown as "implementing this interface".

Friends And Related Function Documentation

◆ get_help_page_message()

std::string get_help_page_message ( ) const
related

Returns a message that can be appended to the (positional) options help page info.

Returns
A string that contains information on the performed validation.
Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

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_type >, and seqan3::arithmetic_range_validator.

◆ operator()()

void operator() ( value_type const &  cmp) const
related

Validates the value 'cmp' and throws a seqan3::validation_failed on failure.

Template Parameters
value_typeThe type of the value to be validated.
Parameters
[in,out]cmpThe value to be validated.
Exceptions
seqan3::validation_failedif value 'cmp' does not pass validation.
Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

◆ value_type()

using value_type
related

The type of value on which the validator is called on.

Attention
This is a concept requirement, not an actual typedef (however types satisfying this concept will provide an implementation).

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