miral::CommandLineOption Class Reference

Add a user configuration option to Mir's option handling. The callback will be invoked during initialisation with a value supplied from the command line, environment variable, config file or the default. More...

#include <miral/command_line_option.h>

Public Member Functions
	CommandLineOption (std::function< void(int value)> callback, std::string const &option, std::string const &description, int default_value)
	CommandLineOption (std::function< void(double value)> callback, std::string const &option, std::string const &description, double default_value)
	CommandLineOption (std::function< void(std::string const &value)> callback, std::string const &option, std::string const &description, std::string const &default_value)
	CommandLineOption (std::function< void(std::string const &value)> callback, std::string const &option, std::string const &description, char const *default_value)
	CommandLineOption (std::function< void(bool value)> callback, std::string const &option, std::string const &description, bool default_value)
	CommandLineOption (std::function< void(mir::optional_value< int > const &value)> callback, std::string const &option, std::string const &description)
	CommandLineOption (std::function< void(mir::optional_value< std::string > const &value)> callback, std::string const &option, std::string const &description)
	CommandLineOption (std::function< void(mir::optional_value< bool > const &value)> callback, std::string const &option, std::string const &description)
	CommandLineOption (std::function< void(bool is_set)> callback, std::string const &option, std::string const &description)
void	operator() (mir::Server &server) const
	~CommandLineOption ()
	CommandLineOption (CommandLineOption const &)
auto	operator= (CommandLineOption const &) -> CommandLineOption &

Detailed Description

Add a user configuration option to Mir's option handling. The callback will be invoked during initialisation with a value supplied from the command line, environment variable, config file or the default.

Constructor & Destructor Documentation

CommandLineOption() [1/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(int value)>	callback,
		std::string const &	option,
		std::string const &	description,
		int	default_value
	)

CommandLineOption() [2/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(double value)>	callback,
		std::string const &	option,
		std::string const &	description,
		double	default_value
	)

CommandLineOption() [3/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(std::string const &value)>	callback,
		std::string const &	option,
		std::string const &	description,
		std::string const &	default_value
	)

CommandLineOption() [4/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(std::string const &value)>	callback,
		std::string const &	option,
		std::string const &	description,
		char const *	default_value
	)

CommandLineOption() [5/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(bool value)>	callback,
		std::string const &	option,
		std::string const &	description,
		bool	default_value
	)

CommandLineOption() [6/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(mir::optional_value< int > const &value)>	callback,
		std::string const &	option,
		std::string const &	description
	)

CommandLineOption() [7/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(mir::optional_value< std::string > const &value)>	callback,
		std::string const &	option,
		std::string const &	description
	)

CommandLineOption() [8/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(mir::optional_value< bool > const &value)>	callback,
		std::string const &	option,
		std::string const &	description
	)

CommandLineOption() [9/10]

miral::CommandLineOption::CommandLineOption	(	std::function< void(bool is_set)>	callback,
		std::string const &	option,
		std::string const &	description
	)

~CommandLineOption()

miral::CommandLineOption::~CommandLineOption

(

)

CommandLineOption() [10/10]

miral::CommandLineOption::CommandLineOption

(

CommandLineOption const &

)

Member Function Documentation

operator()()

void miral::CommandLineOption::operator()

(

mir::Server &

server

)

const

operator=()

auto miral::CommandLineOption::operator=

(

CommandLineOption const &

)

-> CommandLineOption &

---

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

• include/miral/command_line_option.h