Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234]

Nc4	(Undefined by default) Use shorter error message from checks/asserts: do not show the check condition in the error message
Nyml
Ndetail	CRTP base providing read-only methods for ConstNodeRef and NodeRef
CRoNodeMethods
Nextra
CEventHandlerInts	A parser event handler that creates a compact representation of the YAML tree in a contiguous buffer of integers
CLocation	Holds a source or yaml file position, for example when an error is detected; See also location_format() and location_format_with_context()
CErrorDataBasic	Data for a basic error
CErrorDataParse	Data for a parse error
CErrorDataVisit	Data for a visit error
CParserOptions	Options to give to the parser to control its behavior
CCallbacks	A c-style callbacks class to customize behavior on errors or allocation
CEmitter	A stateful emitter, for use with a writer such as WriterBuf, WriterFile, or WriterOStream
CEmitOptions	A lightweight object containing options to be used when emitting
Cas_json	Mark a tree or node to be emitted as yaml when using operator<<, with options
Cas_yaml	Mark a tree or node to be emitted as yaml when using operator<<
CExceptionBasic	Exception thrown by the default basic error implementation
CExceptionParse	Exception thrown by the default parse error implementation
CExceptionVisit	Exception thrown by the default visit error implementation
Cescaped_scalar	Formatting helper to escape a scalar with escape_scalar_fn()
CEventHandlerStack	Use this class a base of implementations of event handler to simplify the stack logic
CEventHandlerTree	The event handler to create a ryml Tree
CFilterResult	Abstracts the fact that a scalar filter result may not fit in the intended memory
CFilterResultExtending	Abstracts the fact that a scalar filter result may not fit in the intended memory
CFilterProcessorSrcDst	Filters an input string into a different output string
CFilterProcessorInplaceEndExtending	Filters in place
CFilterProcessorInplaceMidExtending	Filters in place
CParseEngine	This is the main driver of parsing logic: it scans the YAML or JSON source for tokens, and emits the appropriate sequence of parsing events to its event handler
CKey
CConstNodeRef	Holds a pointer to an existing tree, and a node id
CNodeRef	A reference to a node in an existing yaml tree, offering a more convenient API than the index-based API used in the tree
CNodeType	Wraps a NodeType_e element with some syntactic sugar and predicates
CLineContents	Helper to control the line contents while parsing a buffer
CParserState
CReferenceResolver	Reusable object to resolve references/aliases in a Tree
CTagCache	Accelerator structure to reduce memory requirements by enabling reuse of resolved tags
CEntry
CLookupResult
CTagDirective
CTagDirectiveRange
CTagDirectives
CNodeScalar	Node scalar is a csubstr, which may be tagged and anchored
CNodeInit	Convenience class to initialize nodes
CNodeData	Data for each YAML node
CTree
Clookup_result
CWriterFile	A writer that outputs to a file
CWriterOStream	A writer that outputs to an STL-like ostream
CWriterBuf	Writer to a substr
Nfmt
Cboolalpha_
Cintegral_	Format an integral type with a custom radix
Cintegral_padded_	Format an integral type with a custom radix, and pad with zeroes on the left
Coverflow_checked_
Creal_
Craw_wrapper_
Cleft_
Ccenter_
Cright_
Cis_string	Traits class to mark a type as a string type, meaning c4::to_csubstr() can be used directly instead of c4::to_chars() when formatting the string
Cis_writeable_string	Traits class to mark a type as a writeable string type, meaning c4::to_substr() can be used directly instead of c4::from_chars() when reading the string
Cis_string< basic_substring< C > >
Cis_string< const basic_substring< char > >
Cis_string< const basic_substring< const char > >
Cis_writeable_string< basic_substring< char > >
Cis_writeable_string< const basic_substring< char > >
Cis_compatible_char_ptr
Ccan_borrow_char_ptr
Cbasic_substring	Non-owning string-view, consisting of a character pointer and a length
Cfirst_of_any_result
Cis_string< std::string >
Cis_string< const std::string >
Cis_writeable_string< std::string >
Cis_string< std::string_view >
Cis_string< const std::string_view >
Cis_string< std::vector< char, Alloc > >
Cis_string< const std::vector< char, Alloc > >
Cis_writeable_string< std::vector< char, Alloc > >
Cemit_only_vec2	Example scalar type, serialized only
Cemit_only_vec3	Example scalar type, serialized only
Cemit_only_vec4	Example scalar type, serialized only
CErrorHandlerExample	Example error handler, required for some of the quickstart examples
CGlobalAllocatorExample
Cmy_map_type	Example user container type: map-like
Cmy_seq_type	Example user container type: seq-like
Cmy_type	Example user container type with nested container members
Cparse_only_vec2	Example scalar type, deserialized only
Cparse_only_vec3	Example scalar type, deserialized only
Cparse_only_vec4	Example scalar type, deserialized only
CPerTreeMemoryExample	Example for a per-tree memory allocator
CScopedErrorHandlerExample	Shows how to create a scoped error handler
Cvec2	Example scalar type, serialized and deserialized
Cvec3	Example scalar type, serialized and deserialized
Cvec4	Example scalar type, serialized and deserialized