MySQL 8.3.0
Source Code Documentation
Mysql::Tools::Base::Options::String_option Class Reference

String value option. More...

#include <string_option.h>

Inheritance diagram for Mysql::Tools::Base::Options::String_option:
[legend]

Public Member Functions

 String_option (std::optional< std::string > *value, std::string name, std::string description)
 Constructs new string option. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_string_option< String_option >
String_optionset_value (std::string value)
 Sets value for this option. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_value_option< T_type >
T_type * value_optional ()
 Sets arg_type to OPT_ARG - doesn't require argument to be specified when using this option. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
 ~Abstract_option () override
 
void add_callback (std::function< void(char *)> *callback)
 Adds new callback for this option for option_parsed() event to callback chain. More...
 
T_type * set_short_character (char code)
 Sets optid to given character to make possible usage of short option alternative. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::I_option
virtual ~I_option ()
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_string_option< String_option >
 Abstract_string_option (std::optional< std::string > *value, ulong var_type, std::string name, std::string description)
 Constructs new string option. More...
 
- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_value_option< T_type >
 Abstract_value_option (void *value, ulong var_type, std::string name, std::string description, uint64 default_value)
 Constructs new option with value argument. More...
 
- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
 Abstract_option (void *value, ulong var_type, std::string name, std::string description, longlong default_value)
 Constructs new option. More...
 
my_option get_my_option () override
 Returns my_getopt internal option data structure representing this option. More...
 
void set_option_changed_listener (I_option_changed_listener *listener) override
 Method to set listener on option changed events. More...
 
- Protected Attributes inherited from Mysql::Tools::Base::Options::Abstract_string_option< String_option >
std::optional< std::string > * m_destination_value
 
- Protected Attributes inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
my_option m_option_structure
 
- Static Protected Attributes inherited from Mysql::Tools::Base::Options::I_option
static uint32 last_optid = 256
 

Detailed Description

String value option.

Constructor & Destructor Documentation

◆ String_option()

String_option::String_option ( std::optional< std::string > *  value,
std::string  name,
std::string  description 
)

Constructs new string option.

Parameters
valuePointer to string object to receive option value.
nameName of option. It is used in command line option name as –name.
descriptionDescription of option to be printed in –help.

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