sharg/main_dev/config_8hpp_source.html

// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin

// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik

// SPDX-License-Identifier: BSD-3-Clause


#pragma once


#include <sharg/validators.hpp>


namespace sharg

{


template <typename validator_t = detail::default_validator>


struct config

{

    static_assert(sharg::validator<validator_t>, "The validator passed to sharg::config must model sharg::validator");


    char short_id{'\0'};


    std::string long_id{};


    std::string description{};


    std::string default_message{};


    bool advanced{false};


    bool hidden{false};


    bool required{false};


    validator_t validator{};

};


} // namespace sharg

std::string

sharg::validator
The concept for option validators passed to add_option/positional_option.
Definition validators.hpp:49

sharg::config
Option struct that is passed to the sharg::parser::add_option() function.
Definition config.hpp:43

sharg::config::description
std::string description
The description to be shown on any (exported) help page.
Definition config.hpp:68

sharg::config::long_id
std::string long_id
The long identifier for the option (e.g. "age", making the option callable via --age).
Definition config.hpp:62

sharg::config::hidden
bool hidden
Whether the option should be hidden.
Definition config.hpp:117

sharg::config::advanced
bool advanced
Whether the option should only be displayed on the advanced help page.
Definition config.hpp:105

sharg::config::required
bool required
Whether the option is required.
Definition config.hpp:129

sharg::config::short_id
char short_id
The short identifier for the option (e.g. 'a', making the option callable via -a).
Definition config.hpp:53

sharg::config::default_message
std::string default_message
The default message to be shown on any (exported) help page.
Definition config.hpp:87

validators.hpp
Provides some standard validators for (positional) options.