c4::yml::ParserOptions Struct Reference

Options to give to the parser to control its behavior. More...

#include <common.hpp>

Public Member Functions
	ParserOptions ()=default
source location tracking
ParserOptions &	locations (bool enabled) noexcept
	enable/disable source location tracking More...
bool	locations () const noexcept
	query source location tracking status More...
detection of @ref FLOW_ML container style
ParserOptions &	detect_flow_ml (bool enabled) noexcept
	enable/disable detection of FLOW_ML container style. More...
bool	detect_flow_ml () const noexcept
	query status of detection of FLOW_ML container style. More...
scalar filtering status (experimental; disable at your discretion)
ParserOptions &	scalar_filtering (bool enabled) noexcept
	enable/disable scalar filtering while parsing More...
bool	scalar_filtering () const noexcept
	query scalar filtering status More...

Detailed Description

Options to give to the parser to control its behavior.

Definition at line 346 of file common.hpp.

Constructor & Destructor Documentation

ParserOptions()

c4::yml::ParserOptions::ParserOptions ( )

default

Member Function Documentation

locations() [1/2]

ParserOptions& c4::yml::ParserOptions::locations ( bool  enabled )

inlinenoexcept

enable/disable source location tracking

Definition at line 369 of file common.hpp.

    {
        if(enabled)
            flags |= LOCATIONS;
        else
            flags &= ~LOCATIONS;
        return *this;
    }

locations() [2/2]

bool c4::yml::ParserOptions::locations ( ) const

inlinenoexcept

query source location tracking status

Definition at line 378 of file common.hpp.

{ return (flags & LOCATIONS); }

detect_flow_ml() [1/2]

ParserOptions& c4::yml::ParserOptions::detect_flow_ml ( bool  enabled )

inlinenoexcept

enable/disable detection of FLOW_ML container style.

When enabled, the parser will set FLOW_ML as the style of flow containers which have the terminating bracket on a line different from that of the opening bracket.

Definition at line 391 of file common.hpp.

    {
        if(enabled)
            flags |= DETECT_FLOW_ML;
        else
            flags &= ~DETECT_FLOW_ML;
        return *this;
    }

detect_flow_ml() [2/2]

bool c4::yml::ParserOptions::detect_flow_ml ( ) const

inlinenoexcept

query status of detection of FLOW_ML container style.

Definition at line 400 of file common.hpp.

{ return (flags & DETECT_FLOW_ML); }

scalar_filtering() [1/2]

ParserOptions& c4::yml::ParserOptions::scalar_filtering ( bool  enabled )

inlinenoexcept

enable/disable scalar filtering while parsing

Definition at line 410 of file common.hpp.

    {
        if(enabled)
            flags |= SCALAR_FILTERING;
        else
            flags &= ~SCALAR_FILTERING;
        return *this;
    }

scalar_filtering() [2/2]

bool c4::yml::ParserOptions::scalar_filtering ( ) const

inlinenoexcept

query scalar filtering status

Definition at line 419 of file common.hpp.

{ return (flags & SCALAR_FILTERING); }

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.11.1/src/c4/yml/common.hpp