nlib
nn::nlib::exi::XmlStreamReaderSettings Class Reference

Structure used as the initialization options for XmlStreamReader. More...

#include "nn/nlib/exi/XmlStreamReader.h"

Public Member Functions

constexpr XmlStreamReaderSettings () noexcept
 Configures the default settings.
 

Public Attributes

Preserve preserve
 Sets the fidelity options. More...
 
Alignment alignment
 Specifies the alignment of the binary XML to read. More...
 
bool fragment
 Reads binary XML that supports multiple root nodes (aka XML fragments). More...
 
bool isVersionIgnored
 By setting this option to true during read operations, you can ignore the version check when reading the binary XML. More...
 
XmlProcessor processor
 Specifies whether to read binary XML or text-based XML. More...
 
size_t tempStringMaxLength
 Specifies the length of the string that stores the temporary buffer used when reading XML comments and processing instructions. More...
 

Detailed Description

Structure used as the initialization options for XmlStreamReader.

Description
Most of the time, binary XML can be read without problems using the default settings.
Using non-default settings tends to be required in the following cases.

Definition at line 35 of file XmlStreamReader.h.

Member Data Documentation

◆ alignment

nn::nlib::exi::XmlStreamReaderSettings::alignment

Specifies the alignment of the binary XML to read.

Description
This does not need to be set if a binary XML is written with XmlStreamWriterSettings::encodeOptions set to true.
The default is nn::nlib::exi::ALIGNMENT_BIT_PACKED.

Definition at line 37 of file XmlStreamReader.h.

◆ fragment

nn::nlib::exi::XmlStreamReaderSettings::fragment

Reads binary XML that supports multiple root nodes (aka XML fragments).

Description
The default is false.
This does not need to be set if a binary XML is written with XmlStreamWriterSettings::encodeOptions set to true.

Definition at line 38 of file XmlStreamReader.h.

◆ isVersionIgnored

nn::nlib::exi::XmlStreamReaderSettings::isVersionIgnored

By setting this option to true during read operations, you can ignore the version check when reading the binary XML.

Description
The default is false.

Definition at line 39 of file XmlStreamReader.h.

◆ preserve

nn::nlib::exi::XmlStreamReaderSettings::preserve

Sets the fidelity options.

Description
This does not need to be set if a binary XML is written with XmlStreamWriterSettings::encodeOptions set to true.

Definition at line 36 of file XmlStreamReader.h.

◆ processor

nn::nlib::exi::XmlStreamReaderSettings::processor

Specifies whether to read binary XML or text-based XML.

Description
Specifying XML_PROCESSOR_EXI reads a binary XML file. Specifying XML_PROCESSOR_TEXT reads a text XML file.
For text-based XML, the only supported encoding is UTF-8. Other options are ignored. The default is XML_PROCESSOR_EXI.

Definition at line 40 of file XmlStreamReader.h.

◆ tempStringMaxLength

nn::nlib::exi::XmlStreamReaderSettings::tempStringMaxLength

Specifies the length of the string that stores the temporary buffer used when reading XML comments and processing instructions.

Description
The default value is 1023.

Definition at line 41 of file XmlStreamReader.h.


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