Seastar
High performance C++ framework for concurrent servers
Public Member Functions | Public Attributes | List of all members
seastar::program_options::value< T > Class Template Reference

Detailed Description

template<typename T = std::monostate>
class seastar::program_options::value< T >

A configuration option value.

Template Parameters
Tthe type of the contained value.

#include <seastar/util/program-options.hh>

Inheritance diagram for seastar::program_options::value< T >:
seastar::program_options::basic_value

Public Member Functions

 value (option_group &group, std::string name, std::optional< T > default_value, std::string description)
 
 value (option_group &group, std::string name, unused)
 Construct an unused value.
 
 value (value &&)=default
 
 operator bool () const
 Is there a contained value?
 
bool defaulted () const
 Does this value still contain a default-value?
 
const T & get_value () const
 Return the contained value, assumes there is one, see operator bool().
 
T & get_value ()
 
void set_default_value (T value)
 
void set_value (T value)
 
bool used () const
 
const std::string & name () const
 
const std::string & description () const
 
void describe (options_descriptor &descriptor) const
 
void mutate (options_mutator &mutator)
 

Public Attributes

option_group_group
 
bool _used = true
 
std::string _name
 
std::string _description
 

Constructor & Destructor Documentation

◆ value()

template<typename T = std::monostate>
seastar::program_options::value< T >::value ( option_group group,
std::string  name,
std::optional< T >  default_value,
std::string  description 
)
inline

Construct a value.

Parameters
group- the group containing this value
name- the name of this value
default_value- the default value, can be unset
description- the description of the value

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