nlib
nn::nlib::exi::XmlStreamReaderSettings クラス

XmlStreamReaderの初期化オプションとなる構造体です。 [詳解]

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

公開メンバ関数

constexpr XmlStreamReaderSettings () noexcept
 デフォルト設定がセットされます。
 

公開変数類

Preserve preserve
 各種フィデリティオプションを設定します。 [詳解]
 
Alignment alignment
 読み込むバイナリXMLのアライメントを指定します。 [詳解]
 
bool fragment
 複数のルートノードを持つXML(XMLフラグメント)をサポートしたバイナリXMLを読み込みます。 [詳解]
 
bool isVersionIgnored
 読み込み時にtrueにすると、バイナリXML読み込み時にバージョンのチェックを行いません。 [詳解]
 
XmlProcessor processor
 バイナリXMLを読み込むかテキストXMLを読み込むか指定します。 [詳解]
 
size_t tempStringMaxLength
 XMLコメントとProcessingInstructionの読み込みに用いるテンポラリバッファが格納できる文字列長を指定します。 [詳解]
 

詳解

XmlStreamReaderの初期化オプションとなる構造体です。

説明
大抵の場合、デフォルト設定で問題なくバイナリXMLを読めます。
主にデフォルト以外の設定が必要なのは以下のような場合です。
  • XmlStreamWriterSettings::encodeOptionsfalseにしていて、デフォルト設定以外の設定でバイナリXMLを書き込んでいる場合。
  • コメント等の文字列のサイズが大きいことが予想される場合。

XmlStreamReader.h35 行目に定義があります。

メンバ詳解

◆ alignment

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

読み込むバイナリXMLのアライメントを指定します。

説明
XmlStreamWriterSettings::encodeOptionstrueにしてバイナリXMLを書き込んだ場合には設定する必要がありません。
デフォルトはnn::nlib::exi::ALIGNMENT_BIT_PACKEDです。

XmlStreamReader.h37 行目に定義があります。

◆ fragment

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

複数のルートノードを持つXML(XMLフラグメント)をサポートしたバイナリXMLを読み込みます。

説明
デフォルトはfalseです。
XmlStreamWriterSettings::encodeOptionstrueにしてバイナリXMLを書き込んだ場合 には設定する必要がありません。

XmlStreamReader.h38 行目に定義があります。

◆ isVersionIgnored

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

読み込み時にtrueにすると、バイナリXML読み込み時にバージョンのチェックを行いません。

説明
デフォルトはfalseです。

XmlStreamReader.h39 行目に定義があります。

◆ preserve

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

各種フィデリティオプションを設定します。

説明
XmlStreamWriterSettings::encodeOptionstrueにしてバイナリXMLを書き込んだ場合には設定する必要がありません。

XmlStreamReader.h36 行目に定義があります。

◆ processor

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

バイナリXMLを読み込むかテキストXMLを読み込むか指定します。

説明
XML_PROCESSOR_EXI にするとバイナリXMLを読み込みます。 XML_PROCESSOR_TEXT にするとテキストのXMLを読み込みます。
テキストXMLの場合はエンコーディングはutf-8のみサポートされます。 その他のオプションは無視されます。 デフォルトはXML_PROCESSOR_EXI です。

XmlStreamReader.h40 行目に定義があります。

◆ tempStringMaxLength

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

XMLコメントとProcessingInstructionの読み込みに用いるテンポラリバッファが格納できる文字列長を指定します。

説明
デフォルト値は1023です。

XmlStreamReader.h41 行目に定義があります。


このクラス詳解は次のファイルから抽出されました: