Yaml::ReaderLine Class Reference

Line information structure. More...

Collaboration diagram for Yaml::ReaderLine:

Public Types
enum class	eFlag : uint8_t { LiteralScalarFlag , FoldedScalarFlag , ScalarNewlineFlag }

Public Member Functions
	ReaderLine (std::string data="", const size_t no=0, const size_t offset=0, const Node::eType type=Node::eType::None, const unsigned char flags=0)
	Constructor. More...
void	SetFlag (const eFlag flag)
	Set flag. More...
void	SetFlags (const unsigned char flags)
	Set flags by mask value. More...
void	UnsetFlag (const eFlag flag)
	Unset flag. More...
void	UnsetFlags (const unsigned char flags)
	Unset flags by mask value. More...
bool	GetFlag (const eFlag flag) const
	Get flag value. More...
void	CopyScalarFlags (ReaderLine *from)
	Copy and replace scalar flags from another ReaderLine. More...

Public Attributes
std::string	Data
	Data of line. More...
size_t	No
	Line number. More...
size_t	Offset
	Offset to first character in data. More...
Node::eType	Type
	Type of line. More...
unsigned char	Flags
	Flags of line. More...
ReaderLine *	NextLine {nullptr}
	Pointer to next line. More...

Static Public Attributes
static const unsigned char	FlagMask [3] = {0x01, 0x02, 0x04}

Detailed Description

Line information structure.

Member Enumeration Documentation

eFlag

enum Yaml::ReaderLine::eFlag : uint8_t

strong

Enumerator
LiteralScalarFlag	Literal scalar type, defined as "|".
FoldedScalarFlag	Folded scalar type, defined as "<".
ScalarNewlineFlag	Scalar ends with a newline.

Constructor & Destructor Documentation

ReaderLine()

Yaml::ReaderLine::ReaderLine ( std::string  data = "", const size_t  no = 0, const size_t  offset = 0, const Node::eType  type = Node::eType::None, const unsigned char  flags = 0  )

inlineexplicit

Constructor.

Member Function Documentation

CopyScalarFlags()

void Yaml::ReaderLine::CopyScalarFlags ( ReaderLine *  from )

inline

Copy and replace scalar flags from another ReaderLine.

References FlagMask, and Flags.

GetFlag()

bool Yaml::ReaderLine::GetFlag ( const eFlag  flag ) const

inline

Get flag value.

References FlagMask, and Flags.

SetFlag()

void Yaml::ReaderLine::SetFlag ( const eFlag  flag )

inline

Set flag.

References FlagMask, and Flags.

SetFlags()

void Yaml::ReaderLine::SetFlags ( const unsigned char  flags )

inline

Set flags by mask value.

References Flags.

UnsetFlag()

void Yaml::ReaderLine::UnsetFlag ( const eFlag  flag )

inline

Unset flag.

References FlagMask, and Flags.

UnsetFlags()

void Yaml::ReaderLine::UnsetFlags ( const unsigned char  flags )

inline

Unset flags by mask value.

References Flags.

Member Data Documentation

Data

std::string Yaml::ReaderLine::Data

Data of line.

FlagMask

const unsigned char Yaml::ReaderLine::FlagMask = {0x01, 0x02, 0x04}

static

Referenced by CopyScalarFlags(), GetFlag(), SetFlag(), and UnsetFlag().

Flags

unsigned char Yaml::ReaderLine::Flags

Flags of line.

Referenced by CopyScalarFlags(), GetFlag(), SetFlag(), SetFlags(), UnsetFlag(), and UnsetFlags().

NextLine

ReaderLine* Yaml::ReaderLine::NextLine {nullptr}

Pointer to next line.

No

size_t Yaml::ReaderLine::No

Line number.

Offset

size_t Yaml::ReaderLine::Offset

Offset to first character in data.

Type

Node::eType Yaml::ReaderLine::Type

Type of line.

---

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

• /nebulastream/nes-common/src/Util/yaml/Yaml.cpp