CLI11
C++11 Command Line Interface Parser
|
#include <Validators.hpp>
Public Types | |
using | result_t = uint64_t |
![]() | |
enum | Options { CASE_SENSITIVE = 0, CASE_INSENSITIVE = 1, UNIT_OPTIONAL = 0, UNIT_REQUIRED = 2, DEFAULT = CASE_INSENSITIVE | UNIT_OPTIONAL } |
Public Member Functions | |
AsSizeValue (bool kb_is_1000) | |
![]() | |
template<typename Number > | |
AsNumberWithUnit (std::map< std::string, Number > mapping, Options opts=DEFAULT, const std::string &unit_name="UNIT") | |
![]() | |
Validator (std::string validator_desc) | |
Construct a Validator with just the description string. | |
Validator (std::function< std::string(std::string &)> op, std::string validator_desc, std::string validator_name="") | |
Validator & | operation (std::function< std::string(std::string &)> op) |
Set the Validator operation function. | |
std::string | operator() (std::string &str) const |
std::string | operator() (const std::string &str) const |
Validator & | description (std::string validator_desc) |
Specify the type string. | |
std::string | get_description () const |
Generate type description information for the Validator. | |
Validator & | name (std::string validator_name) |
Specify the type string. | |
const std::string & | get_name () const |
Get the name of the Validator. | |
Validator & | active (bool active_val=true) |
Specify whether the Validator is active or not. | |
Validator & | non_modifying (bool no_modify=true) |
Specify whether the Validator can be modifying or not. | |
bool | get_active () const |
Get a boolean if the validator is active. | |
bool | get_modifying () const |
Get a boolean if the validator is allowed to modify the input returns true if it can modify the input. | |
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. | |
Additional Inherited Members | |
![]() | |
std::function< std::string()> | desc_function_ {[]() { return std::string{}; }} |
This is the description function, if empty the description_ will be used. | |
std::function< std::string(std::string &)> | func_ {[](std::string &) { return std::string{}; }} |
std::string | name_ |
The name for search purposes of the Validator. | |
bool | active_ {true} |
Enable for Validator to allow it to be disabled if need be. | |
bool | non_modifying_ {false} |
specify that a validator should not modify the input | |
Converts a human-readable size string (with unit literal) to uin64_t size. Example: "100" => 100 "1 b" => 100 "10Kb" => 10240 // you can configure this to be interpreted as kilobyte (*1000) or kibibyte (*1024) "10 KB" => 10240 "10 kb" => 10240 "10 kib" => 10240 // *i, *ib are always interpreted as *bibyte (*1024) "10kb" => 10240 "2 MB" => 2097152 "2 EiB" => 2^61 // Units up to exibyte are supported
|
inlineexplicit |
If kb_is_1000 is true, interpret 'kb', 'k' as 1000 and 'kib', 'ki' as 1024 (same applies to higher order units as well). Otherwise, interpret all literals as factors of 1024. The first option is formally correct, but the second interpretation is more wide-spread (see https://en.wikipedia.org/wiki/Binary_prefix).