SeqAn3
seqan3::regex_validator< std::vector< std::string > > Class Template Reference

A validator that checks if each value in a container satisfies a regex expression. More...

#include <seqan3/argument_parser/validators.hpp>

Inheritance diagram for seqan3::regex_validator< std::vector< std::string > >:
[legend]

Public Types

using value_type = std::vector< std::string >
 Type of values that are tested by validator.
 

Public Member Functions

std::string get_help_page_message () const
 Returns a message that can be appended to the (positional) options help page info.
 
void operator() (value_type const &cmp) const
 Tests whether cmp lies inside values. More...
 
 regex_validator (std::string const &pattern_)
 Constructing from a vector. More...
 

Related Functions

(Note that these are not member functions.)

Requirements for seqan3::validator_concept

You can expect these (meta-)functions on all types that implement seqan3::validator_concept.

void operator() (value_type const &cmp) const
 Validates the value 'cmp' and throws a seqan3::validation_error on failure. More...
 

Detailed Description

template<>
class seqan3::regex_validator< std::vector< std::string > >

A validator that checks if each value in a container satisfies a regex expression.

Constructor & Destructor Documentation

◆ regex_validator()

seqan3::regex_validator< std::vector< std::string > >::regex_validator ( std::string const &  pattern_)
inline

Constructing from a vector.

Parameters
[in]pattern_The vector of valid values to test.

Member Function Documentation

◆ operator()()

void seqan3::regex_validator< std::vector< std::string > >::operator() ( value_type const &  cmp) const
inline

Tests whether cmp lies inside values.

Parameters
[in]cmpThe value to validate.
Exceptions
parser_invalid_argument

Friends And Related Function Documentation

◆ operator()()

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

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

Template Parameters
value_typeThe type of the value to be validated.
Parameters
[in,out]cmpThe value to be validated.
Exceptions
seqan3::validation_errorif 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).

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