SettingToBool overloads

Synopses

Declared in <common/args.h>

Convert a settings value to an optional boolean.

std::optional<bool>
SettingToBool(common::SettingsValue const& value);

» more...

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

bool
SettingToBool(
    common::SettingsValue const& value,
    bool default_value);

» more...

Return Value

  • The boolean value, or std::nullopt when unset.

  • The boolean value, or the provided default when unset.

Parameters

Name

Description

value

The settings value to convert.

default_value

Value returned when the setting is unset.

Created with MrDocs