SettingTo

SettingTo overloads

Synopses

Declared in <common/args.h>

Convert a settings value to an optional integer.

template<std::integral Int>
std::optional<Int>
SettingTo(common::SettingsValue const& value);
» more...

Convert a settings value to an integer, using a default when unset.

template<std::integral Int>
Int
SettingTo(
    common::SettingsValue const& value,
    Int default_value);
» more...

Return Value

  • The integer value, or std::nullopt when unset.
  • The integer value, or the provided default when unset.

Parameters

NameDescription
valueThe settings value to convert.
default_valueValue returned when the setting is unset.