c4::yml::Location Struct Reference

holds a source or yaml file position, for example when an error is detected; See also location_format() and location_format_with_context(). More...

#include <common.hpp>

Public Member Functions
	operator bool () const noexcept
	Location () noexcept
	Location (size_t l) noexcept
	Location (size_t l, size_t c) noexcept
	Location (size_t b, size_t l, size_t c) noexcept
	Location (csubstr n, size_t l) noexcept
	Location (csubstr n, size_t l, size_t c) noexcept
	Location (csubstr n, size_t b, size_t l, size_t c) noexcept
	Location (const char *n, size_t l) noexcept
	Location (const char *n, size_t l, size_t c) noexcept
	Location (const char *n, size_t b, size_t l, size_t c) noexcept

Public Attributes
size_t	offset
	number of bytes from the beginning of the source buffer
size_t	line
	line
size_t	col
	column
csubstr	name
	name of the file

Detailed Description

holds a source or yaml file position, for example when an error is detected; See also location_format() and location_format_with_context().

Definition at line 228 of file common.hpp.

Constructor & Destructor Documentation

Location() [1/10]

c4::yml::Location::Location ( )

inlinenoexcept

Definition at line 237 of file common.hpp.

: offset(npos), line(npos), col(npos), name() {}

Location() [2/10]

c4::yml::Location::Location ( size_t l )

inlinenoexcept

Definition at line 238 of file common.hpp.

: offset(npos), line(l), col(npos), name() {}

Location() [3/10]

c4::yml::Location::Location ( size_t l, size_t c )

inlinenoexcept

Definition at line 239 of file common.hpp.

: offset(npos), line(l), col(c   ), name() {}

Location() [4/10]

c4::yml::Location::Location ( size_t b, size_t l, size_t c )

inlinenoexcept

Definition at line 240 of file common.hpp.

: offset(b   ), line(l), col(c   ), name() {}

Location() [5/10]

c4::yml::Location::Location ( csubstr n, size_t l )

inlinenoexcept

Definition at line 241 of file common.hpp.

: offset(npos), line(l), col(npos), name(n) {}

Location() [6/10]

c4::yml::Location::Location ( csubstr n, size_t l, size_t c )

inlinenoexcept

Definition at line 242 of file common.hpp.

: offset(npos), line(l), col(c   ), name(n) {}

Location() [7/10]

c4::yml::Location::Location ( csubstr n, size_t b, size_t l, size_t c )

inlinenoexcept

Definition at line 243 of file common.hpp.

: offset(b   ), line(l), col(c   ), name(n) {}

Location() [8/10]

c4::yml::Location::Location ( const char * n, size_t l )

inlinenoexcept

Definition at line 244 of file common.hpp.

: offset(npos), line(l), col(npos), name(to_csubstr(n)) {}

Location() [9/10]

c4::yml::Location::Location ( const char * n, size_t l, size_t c )

inlinenoexcept

Definition at line 245 of file common.hpp.

: offset(npos), line(l), col(c   ), name(to_csubstr(n)) {}

Location() [10/10]

c4::yml::Location::Location ( const char * n, size_t b, size_t l, size_t c )

inlinenoexcept

Definition at line 246 of file common.hpp.

: offset(b   ), line(l), col(c   ), name(to_csubstr(n)) {}

Member Function Documentation

operator bool()

c4::yml::Location::operator bool ( ) const

inlinenoexcept

Definition at line 235 of file common.hpp.

{ return !name.empty() || line != npos || offset != npos || col != npos; }

Member Data Documentation

offset

size_t c4::yml::Location::offset

number of bytes from the beginning of the source buffer

Definition at line 230 of file common.hpp.

Referenced by Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), c4::yml::location_format(), c4::yml::location_format_with_context(), operator bool(), sample_error_parse(), and sample_location_tracking().

line

size_t c4::yml::Location::line

line

Definition at line 231 of file common.hpp.

Referenced by Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), c4::yml::location_format(), operator bool(), sample_deserialize_error(), sample_error_parse(), sample_location_tracking(), and sample_quick_overview().

col

size_t c4::yml::Location::col

column

Definition at line 232 of file common.hpp.

Referenced by Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), c4::yml::location_format(), c4::yml::location_format_with_context(), operator bool(), sample_deserialize_error(), sample_error_parse(), sample_location_tracking(), and sample_quick_overview().

name

csubstr c4::yml::Location::name

name of the file

Definition at line 233 of file common.hpp.

Referenced by Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), Location(), c4::yml::location_format(), operator bool(), sample_error_basic(), sample_error_parse(), sample_error_visit(), and sample_error_visit_location().

---

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

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