c4::yml::FilterResult Struct Reference

Abstracts the fact that a scalar filter result may not fit in the intended memory. More...

#include <filter_processor.hpp>

Public Member Functions
bool	valid () const noexcept
size_t	required_len () const noexcept
csubstr	get () const

Public Attributes
csubstr	str

Detailed Description

Abstracts the fact that a scalar filter result may not fit in the intended memory.

Definition at line 32 of file filter_processor.hpp.

Member Function Documentation

valid()

bool c4::yml::FilterResult::valid ( ) const

inlinenoexcept

Definition at line 34 of file filter_processor.hpp.

{ return str.str != nullptr; }

required_len()

size_t c4::yml::FilterResult::required_len ( ) const

inlinenoexcept

Definition at line 35 of file filter_processor.hpp.

{ return str.len; }

get()

csubstr c4::yml::FilterResult::get ( ) const

inline

Definition at line 36 of file filter_processor.hpp.

{ _RYML_ASSERT_BASIC(valid()); return str; }

Member Data Documentation

str

csubstr c4::yml::FilterResult::str

Definition at line 37 of file filter_processor.hpp.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.13.0/src/c4/yml/filter_processor.hpp