Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
util::config::ConfigFileYaml Class Referencefinal

Yaml representation of config. More...

#include <ConfigFileYaml.hpp>

Inheritance diagram for util::config::ConfigFileYaml:
Collaboration diagram for util::config::ConfigFileYaml:

Public Member Functions

Value getValue (std::string_view key) const override
 Retrieves the value of configValue.
 
std::vector< Value > getArray (std::string_view key) const override
 Retrieves an array of configuration values.
 
bool containsKey (std::string_view key) const override
 Checks if key exist in configuration file.
 
- Public Member Functions inherited from util::config::ConfigFileInterface

Detailed Description

Yaml representation of config.

Member Function Documentation

◆ containsKey()

bool util::config::ConfigFileYaml::containsKey ( std::string_view key) const
overridevirtual

Checks if key exist in configuration file.

Parameters
keyThe key to search for.
Returns
true if key exists in configuration file, false otherwise.

Implements util::config::ConfigFileInterface.

◆ getArray()

std::vector< Value > util::config::ConfigFileYaml::getArray ( std::string_view key) const
overridevirtual

Retrieves an array of configuration values.

Parameters
keyThe key of the configuration array.
Returns
A vector of configuration values if found, otherwise std::nullopt.

Implements util::config::ConfigFileInterface.

◆ getValue()

Value util::config::ConfigFileYaml::getValue ( std::string_view key) const
overridevirtual

Retrieves the value of configValue.

Parameters
keyThe key of configuration.
Returns
the value assosiated with key.

Implements util::config::ConfigFileInterface.


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