Scarab  v3.1.0
Project 8 C++ Utility Library
Public Types | Public Member Functions | List of all members
Transformer Class Reference

Translate named items to other or a value set. More...

#include <CLI11.hpp>

Inheritance diagram for Transformer:
Inheritance graph

Public Types

using filter_fn_t = std::function< std::string(std::string)>
 

Public Member Functions

template<typename... Args>
 Transformer (std::initializer_list< std::pair< std::string, std::string >> values, Args &&... args)
 This allows in-place construction. More...
 
template<typename T >
 Transformer (T &&mapping)
 direct map of std::string to std::string More...
 
template<typename T , typename F >
 Transformer (T mapping, F filter_function)
 
template<typename T , typename... Args>
 Transformer (T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&... other)
 You can pass in as many filter functions as you like, they nest. More...
 
- Public Member Functions inherited from Validator
 Validator ()=default
 
 Validator (std::string validator_desc)
 Construct a Validator with just the description string. More...
 
 Validator (std::function< std::string(std::string &)> op, std::string validator_desc, std::string validator_name="")
 
Validatoroperation (std::function< std::string(std::string &)> op)
 Set the Validator operation function. More...
 
std::string operator() (std::string &str) const
 
std::string operator() (const std::string &str) const
 
Validatordescription (std::string validator_desc)
 Specify the type string. More...
 
std::string get_description () const
 Generate type description information for the Validator. More...
 
Validatorname (std::string validator_name)
 Specify the type string. More...
 
const std::string & get_name () const
 Get the name of the Validator. More...
 
Validatoractive (bool active_val=true)
 Specify whether the Validator is active or not. More...
 
Validatornon_modifying (bool no_modify=true)
 Specify whether the Validator can be modifying or not. More...
 
bool get_active () const
 Get a boolean if the validator is active. More...
 
bool get_modifying () const
 Get a boolean if the validator is allowed to modify the input returns true if it can modify the input. More...
 
Validator operator & (const Validator &other) const
 
Validator operator| (const Validator &other) const
 
Validator operator! () const
 Create a validator that fails when a given validator succeeds. More...
 

Additional Inherited Members

- Protected Attributes inherited from Validator
std::function< std::string()> desc_function_ {[]() { return std::string{}; }}
 This is the description function, if empty the description_ will be used. More...
 
std::function< std::string(std::string &)> func_ {[](std::string &) { return std::string{}; }}
 
std::string name_
 The name for search purposes of the Validator. More...
 
bool active_ {true}
 Enable for Validator to allow it to be disabled if need be. More...
 
bool non_modifying_ {false}
 specify that a validator should not modify the input More...
 

Detailed Description

Translate named items to other or a value set.

Definition at line 2125 of file CLI11.hpp.

Member Typedef Documentation

◆ filter_fn_t

using filter_fn_t = std::function<std::string(std::string)>

Definition at line 2127 of file CLI11.hpp.

Constructor & Destructor Documentation

◆ Transformer() [1/4]

Transformer ( std::initializer_list< std::pair< std::string, std::string >>  values,
Args &&...  args 
)
inlineexplicit

This allows in-place construction.

Definition at line 2131 of file CLI11.hpp.

◆ Transformer() [2/4]

Transformer ( T &&  mapping)
inlineexplicit

direct map of std::string to std::string

Definition at line 2135 of file CLI11.hpp.

◆ Transformer() [3/4]

Transformer ( mapping,
filter_function 
)
inlineexplicit

This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter both sides of the comparison before computing the comparison.

Definition at line 2139 of file CLI11.hpp.

◆ Transformer() [4/4]

Transformer ( T &&  mapping,
filter_fn_t  filter_fn_1,
filter_fn_t  filter_fn_2,
Args &&...  other 
)
inline

You can pass in as many filter functions as you like, they nest.

Definition at line 2175 of file CLI11.hpp.


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