irccd  3.0.3
Public Member Functions | List of all members
irccd::ini::option Class Reference

option definition. More...

#include <ini.hpp>

Inheritance diagram for irccd::ini::option:

Public Member Functions

 option (std::string key) noexcept
 
 option (std::string key, std::string value) noexcept
 
 option (std::string key, std::vector< std::string > values) noexcept
 
auto get_key () const noexcept -> const std::string &
 
auto get_value () const noexcept -> const std::string &
 

Detailed Description

option definition.

Constructor & Destructor Documentation

◆ option() [1/3]

irccd::ini::option::option ( std::string  key)
noexcept

Construct an empty option.

Precondition
key must not be empty
Parameters
keythe key

◆ option() [2/3]

irccd::ini::option::option ( std::string  key,
std::string  value 
)
noexcept

Construct a single option.

Precondition
key must not be empty
Parameters
keythe key
valuethe value

◆ option() [3/3]

irccd::ini::option::option ( std::string  key,
std::vector< std::string >  values 
)
noexcept

Construct a list option.

Precondition
key must not be empty
Parameters
keythe key
valuesthe values

Member Function Documentation

◆ get_key()

auto irccd::ini::option::get_key ( ) const -> const std::string &
noexcept

Get the option key.

Returns
the key

◆ get_value()

auto irccd::ini::option::get_value ( ) const -> const std::string &
noexcept

Get the option value.

Returns
the value

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