q3::YAMLInputFormat Class Reference

Q3's own YAML input, the fallback for any file nothing more specific claims. More...

#include <yaml_input_format.hpp>

Inheritance diagram for q3::YAMLInputFormat:

Public Member Functions
std::unique_ptr< InputParser >	create_parser () const override
	A YAMLInputParser.
int	detection_priority () const override
	The lowest rank, fallback_detection_priority.
std::string	display_name () const override
	How a log line names a YAML input.
std::vector< std::string >	names () const override
	"yaml", and the "yml" extension spelling.
bool	recognizes (const std::filesystem::path &path) const override
	Any path that is not a directory.
Public Member Functions inherited from q3::InputFormat
virtual	~InputFormat ()=default
virtual bool	claims_working_directory (const std::filesystem::path &) const
virtual void	write_companion_outputs (const InputData &, const generated::Results &) const

Static Public Attributes
static constexpr int	fallback_detection_priority = 0
	Ranked lowest: the fallback answers only when nothing more specific does.

Detailed Description

Q3's own YAML input, the fallback for any file nothing more specific claims.

Definition at line 23 of file yaml_input_format.hpp.

Member Function Documentation

create_parser()

std::unique_ptr< InputParser > q3::YAMLInputFormat::create_parser ( ) const

inlineoverridevirtual

A YAMLInputParser.

Implements q3::InputFormat.

Definition at line 49 of file yaml_input_format.hpp.

detection_priority()

int q3::YAMLInputFormat::detection_priority ( ) const

inlineoverridevirtual

The lowest rank, fallback_detection_priority.

Implements q3::InputFormat.

Definition at line 39 of file yaml_input_format.hpp.

References fallback_detection_priority.

display_name()

std::string q3::YAMLInputFormat::display_name ( ) const

inlineoverridevirtual

How a log line names a YAML input.

Implements q3::InputFormat.

Definition at line 34 of file yaml_input_format.hpp.

names()

std::vector< std::string > q3::YAMLInputFormat::names ( ) const

inlineoverridevirtual

"yaml", and the "yml" extension spelling.

Implements q3::InputFormat.

Definition at line 29 of file yaml_input_format.hpp.

recognizes()

bool q3::YAMLInputFormat::recognizes ( const std::filesystem::path &  path ) const

inlineoverridevirtual

Any path that is not a directory.

Implements q3::InputFormat.

Definition at line 44 of file yaml_input_format.hpp.

Member Data Documentation

fallback_detection_priority

constexpr int q3::YAMLInputFormat::fallback_detection_priority = 0

staticconstexpr

Ranked lowest: the fallback answers only when nothing more specific does.

Definition at line 26 of file yaml_input_format.hpp.

Referenced by detection_priority().

---

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

• src/io/input/parser/yaml_input_format.hpp