seastar::program_options::options_descriptor Class Reference

Detailed Description

Visitor interface for option_group::describe().

See option_group::describe() for more details on the visiting algorithm.

#include <seastar/util/program-options.hh>

Public Member Functions
virtual bool	visit_group_start (const std::string &name, bool used)=0
virtual void	visit_group_end ()=0
virtual bool	visit_value_metadata (const std::string &name, const std::string &description, bool used)=0
virtual void	visit_value ()=0
	Visit a switch (value<std::monostate>).
virtual void	visit_value (const bool *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const int *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const unsigned *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const float *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const double *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const std::string *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const std::set< unsigned > *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const log_level *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const logger_timestamp_style *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const logger_ostream_type *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const memory::alloc_failure_kind *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_value (const std::unordered_map< sstring, log_level > *default_val)=0
	Visit a value (value), default_val is null when value has no default.
virtual void	visit_selection_value (const std::vector< std::string > &candidate_names, const std::size_t *default_candidate)=0
	Visit a selection value (selection_value), default_candidate is null when there is no default candidate.

Member Function Documentation

visit_group_end()

virtual void seastar::program_options::options_descriptor::visit_group_end ( )

pure virtual

Visit the end of the group.

Called after all values and nested groups were visited in the current group.

visit_group_start()

virtual bool seastar::program_options::options_descriptor::visit_group_start ( const std::string &  name, bool  used  )

pure virtual

Visit the start of the group.

Called when entering a group. Groups can be nested, in which case there will be another call to this method, before the current groups is closed.

Returns

whether visitor is interested in the group: true - visit, false - skip.

visit_value_metadata()

virtual bool seastar::program_options::options_descriptor::visit_value_metadata ( const std::string &  name, const std::string &  description, bool  used  )

pure virtual

Visit value metadata, common across all value types.

Called at the start of visiting a value. After this, a call to the appropriate visit_value() overload (or visit_selection_value()) follows.

Returns

whether visitor is interested in the value: true - visit, false - skip.

---

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

• seastar/util/program-options.hh