C++ Actor Framework  0.18
Classes | Public Member Functions | Friends | List of all members
caf::config_option Class Reference

Defines a configuration option for the application. More...

#include <config_option.hpp>

Collaboration diagram for caf::config_option:
Collaboration graph

Classes

struct  meta_state
 Custom vtable-like struct for delegating to type-specific functions and storing type-specific information shared by several config options. More...
 

Public Member Functions

 config_option (string_view category, string_view name, string_view description, const meta_state *meta, void *value=nullptr)
 Constructs a config option.
 
 config_option (const config_option &)
 
 config_option (config_option &&)=default
 
config_optionoperator= (const config_option &)
 
config_optionoperator= (config_option &&)=default
 
string_view category () const noexcept
 Returns the category of the option.
 
string_view long_name () const noexcept
 Returns the name of the option.
 
string_view short_names () const noexcept
 Returns (optional) one-letter short names of the option.
 
string_view description () const noexcept
 Returns a human-readable description of the option.
 
string_view full_name () const noexcept
 Returns the full name for this config option as "<category>.<long name>".
 
error sync (config_value &x) const
 Synchronizes the value of this config option with x and vice versa. More...
 
error store (const config_value &x) const
 
expected< config_valueparse (string_view input) const
 
string_view type_name () const noexcept
 Returns a human-readable representation of this option's expected type.
 
bool is_flag () const noexcept
 Returns whether this config option stores a boolean flag.
 
bool has_flat_cli_name () const noexcept
 Returns whether the category is optional for CLI options.
 

Friends

void swap (config_option &first, config_option &second) noexcept
 

Detailed Description

Defines a configuration option for the application.

Member Function Documentation

◆ sync()

error caf::config_option::sync ( config_value x) const

Synchronizes the value of this config option with x and vice versa.

Tries to perform this sequence of steps:

  • Convert the config value to the type of the config option.
  • Assign the converted value back to the config value to synchronize conversions back to the caller.
  • Store the converted value unless this option is stateless.

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