An opaque handle to something that can be parsed, obtained from config_include_context. More...
Public Member Functions | |
| virtual shared_object | parse (config_parse_options const &options) const =0 |
| Parse whatever it is. More... | |
| virtual shared_origin | origin () const =0 |
| Returns a config_origin describing the origin of the paresable item. More... | |
| virtual config_parse_options const & | options () const =0 |
| Get the initial options, which can be modified then passed to parse(). More... | |
Detailed Description
An opaque handle to something that can be parsed, obtained from config_include_context.
Do not implement this interface; it should only be implemented by the config library. Arbitrary implementations will not work because the library internals assume a specific concrete implementation. Also, this interface is likely to grow new methods over time, so third-party implementations will break.
Definition at line 19 of file config_parseable.hpp.
Member Function Documentation
◆ options()
|
pure virtual |
Get the initial options, which can be modified then passed to parse().
These options will have the right description, includer, and other parameters already set up.
- Returns
- the initial options
Implemented in hocon::parseable.
◆ origin()
|
pure virtual |
Returns a config_origin describing the origin of the paresable item.
Implemented in hocon::parseable.
◆ parse()
|
pure virtual |
Parse whatever it is.
The options should come from config_parseable#options() but you could tweak them if you like.
- Parameters
-
options parse options, should be based on the ones from config_parseable#options()
- Returns
- the parsed object
Implemented in hocon::parseable.
The documentation for this class was generated from the following file:
- hocon/config_parseable.hpp
