seqan3::detail::default_validator< option_value_t > Struct Template Reference

Validator that always returns true. More...

#include <seqan3/argument_parser/validators.hpp>

Inheritance diagram for seqan3::detail::default_validator< option_value_t >:

Public Types
using	option_value_type = option_value_t
	Type of values that are tested by validator.

Public Member Functions
std::string	get_help_page_message () const
	Since no validation is happening the help message is empty.
void	operator() (option_value_t const &) const noexcept
	Value cmp always passes validation because the operator never throws.

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.
void	operator() (option_value_type const &cmp) const
	Validates the value 'cmp' and throws a seqan3::validation_error on failure. More...

Detailed Description

template<typename option_value_t>
struct seqan3::detail::default_validator< option_value_t >

Validator that always returns true.

Template Parameters

option_value_t

Must be a (container of) arithmetic type(s).

The default validator is needed to make the validator parameter of argument_parser::add_option and argument_parser::add_option optional.

Friends And Related Function Documentation

operator()()

void operator() ( option_value_type const &  cmp ) const

related

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

Template Parameters

option_value_type

The type of the value to be validated.

Parameters

[in,out]

cmp

The value to be validated.

Exceptions

seqan3::validation_error

if 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 struct was generated from the following file:

• seqan3/argument_parser/validators.hpp