Sharg 1.1.2-rc.1
The argument parser for bio-c++ tools.
Loading...
Searching...
No Matches
sharg::parsable Concept Reference
Misc

Checks whether the the type can be used in an add_(positional_)option call on the parser. More...

#include <sharg/concept.hpp>

Concept definition

template<typename option_type>
concept sharg::parsable =
(sharg::istreamable<option_type> && sharg::ostreamable<option_type>) || named_enumeration<option_type>
sharg::istreamable
Concept for types that can be parsed from a std::istream via the stream operator.
Definition concept.hpp:37
sharg::named_enumeration
Checks whether the free function sharg::enumeration_names can be called on the type.
Definition enumeration_names.hpp:235
sharg::ostreamable
Concept for types that can be parsed into a std::ostream via the stream operator.
Definition concept.hpp:61
sharg::parsable
Checks whether the the type can be used in an add_(positional_)option call on the parser.
Definition concept.hpp:91

Detailed Description

Checks whether the the type can be used in an add_(positional_)option call on the parser.

Template Parameters
option_typeThe type to check.

Read up on how to make a type model this concept here:

How to make your custom type model sharg::parsable.

Requirements

In order to model this concept, the type must either model sharg::istreamable and sharg::ostreamable or model sharg::named_enumeration<option_type>.

Remarks
For a complete overview, take a look at Parser

This entity is stable. Since version 1.0.

Hide me