PDI::Yaml_region Class Reference

A region in a YAML "file", from start to end. More...

#include <paraconf_wrapper.h>

Classes
struct	Yaml_mark
	a location in a YAML stream More...

Public Member Functions
const std::string &	file () const
	Gives access to the "file" where this region resides.
const Yaml_mark &	start () const
	Gives access to the start location of the region.
const Yaml_mark &	end () const
	Gives access to the end location of the region.

Static Public Member Functions
static std::optional< Yaml_region >	make (PC_tree_t tree)
	Builds a YAML region that contains a given YAML subtree or nothing if the tree is invalid.

Detailed Description

A region in a YAML "file", from start to end.

---

Class Documentation

PDI::Yaml_region::Yaml_mark

struct PDI::Yaml_region::Yaml_mark

a location in a YAML stream

Class Members
size_t	line	the line of the location
size_t	column	the column of the location

Member Function Documentation

file()

const std::string & PDI::Yaml_region::file ( ) const

inline

Gives access to the "file" where this region resides.

Returns

the "file" where this region resides (might be "<string>" if not in a file)

start()

const Yaml_mark & PDI::Yaml_region::start ( ) const

inline

Gives access to the start location of the region.

Returns

the start location of the region

end()

const Yaml_mark & PDI::Yaml_region::end ( ) const

inline

Gives access to the end location of the region.

Returns

the end location of the region

make()

std::optional< Yaml_region > PDI::Yaml_region::make ( PC_tree_t tree )

static

Builds a YAML region that contains a given YAML subtree or nothing if the tree is invalid.

Parameters

tree	the subtree

Returns

the YAML region or an empty optional if the tree was invalid or had no region specified

---

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

• paraconf_wrapper.h