c4::yml::FilterResult Struct Reference

Result for filtering a scalar which 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

Result for filtering a scalar which not fit in the intended memory.

Definition at line 26 of file filter_processor.hpp.

Member Function Documentation

valid()

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

inlinenoexcept

Definition at line 28 of file filter_processor.hpp.

{ return str.str != nullptr; }

Referenced by get().

required_len()

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

inlinenoexcept

Definition at line 29 of file filter_processor.hpp.

{ return str.len; }

get()

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

inline

Definition at line 30 of file filter_processor.hpp.

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

Member Data Documentation

str

csubstr c4::yml::FilterResult::str

Definition at line 31 of file filter_processor.hpp.

Referenced by get(), required_len(), c4::yml::FilterProcessorInplaceEndExtending::result(), c4::yml::FilterProcessorSrcDst::result(), and valid().

---

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

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