SettingToString

SettingToString overloads

Synopses

Declared in <common/args.h>

Convert a settings value to an optional string.

std::optional<std::string>
SettingToString(common::SettingsValue const& value);
» more...

Convert a settings value to a string, using a default when unset.

std::string
SettingToString(
    common::SettingsValue const& value,
    std::string const& default_value);
» more...

Return Value

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

Parameters

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