nlib
nn::nlib::exi::XmlStreamWriterSettings Class Reference

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

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

Public Member Functions

constexpr XmlStreamWriterSettings () noexcept
 Configures the default settings.
 

Public Attributes

bool encodeCookie
 Sets whether to write identification strings at the beginning of the data. More...
 
bool encodeOptions
 Sets whether to write information used to automatically recognize the settings. More...
 
Alignment alignment
 Sets the alignment of the binary XML. More...
 
bool fragment
 Supports writing binary XML that has multiple root nodes (aka XML fragments). The default is false.
 
Preserve preserve
 Sets the fidelity options.
 
int version
 Specifies the version number to record in the binary XML. More...
 
XmlProcessor processor
 Specifies whether to write binary XML or text-based XML. More...
 

Detailed Description

Structure used as the initialization options for XmlStreamWriter.

Description
The default settings can be used to create the highest-speed, most compact binary XML.
Using non-default settings tends to be required in the following cases.

Definition at line 22 of file XmlStreamWriter.h.

Member Data Documentation

§ alignment

nn::nlib::exi::XmlStreamWriterSettings::alignment

Sets the alignment of the binary XML.

Description
The default is nn::nlib::exi::ALIGNMENT_BIT_PACKED. Normally, set nn::nlib::exi::ALIGNMENT_BYTE_ALIGNMENT when debugging the XML parser. (No improvements in speed if this option is set.)

Definition at line 25 of file XmlStreamWriter.h.

§ encodeCookie

nn::nlib::exi::XmlStreamWriterSettings::encodeCookie

Sets whether to write identification strings at the beginning of the data.

Description
If true, the four-byte ASCII string $EXI is written at the beginning of the data.
The default is false.

Definition at line 23 of file XmlStreamWriter.h.

§ encodeOptions

nn::nlib::exi::XmlStreamWriterSettings::encodeOptions

Sets whether to write information used to automatically recognize the settings.

Description
If true, information about the options that were specified to the EXI stream is written. The options are automatically detected upon reading.
The default is false.

Definition at line 24 of file XmlStreamWriter.h.

§ processor

nn::nlib::exi::XmlStreamWriterSettings::processor

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

Description
Using XML_PROCESSOR_EXI writes binary XML. Using XML_PROCESSOR_TEXT writes text-based XML.
For text-based XML, the data is written with UTF-8 encoding. The only valid options are Preserve::pis and Preserve::comments. Other options are ignored.
The default is XML_PROCESSOR_EXI.

Definition at line 29 of file XmlStreamWriter.h.

§ version

nn::nlib::exi::XmlStreamWriterSettings::version

Specifies the version number to record in the binary XML.

Description
For more information, see the following. http://www.w3.org/TR/exi/#version

Definition at line 28 of file XmlStreamWriter.h.


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