nlib
nn::nlib::exi::XmlStreamWriterSettings クラス

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

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

公開メンバ関数

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

公開変数類

bool encodeCookie
 データの先頭に識別用の文字列を書きこむかを設定します。 [詳解]
 
bool encodeOptions
 設定の自動認識のための情報を書き込むかを設定します。 [詳解]
 
Alignment alignment
 バイナリXMLのアライメントを設定します。 [詳解]
 
bool fragment
 複数のルートノードを持つXML(XMLフラグメント)の書き込みをサポートします。デフォルトはfalseです。
 
Preserve preserve
 各種フィデリティオプションを設定します。
 
int version
 バイナリXMLに記録されるバージョン番号を指定します。 [詳解]
 
XmlProcessor processor
 バイナリXMLを書きだすかテキストXMLを書きだすか指定します。 [詳解]
 

詳解

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

説明
デフォルト設定が一番高速でコンパクトなバイナリXMLを生成することができます。
主にデフォルト以外の設定が必要なのは以下のような場合です。

XmlStreamWriter.h22 行目に定義があります。

メンバ詳解

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

バイナリXMLのアライメントを設定します。

説明
デフォルトはnn::nlib::exi::ALIGNMENT_BIT_PACKEDです。 nn::nlib::exi::ALIGNMENT_BYTE_ALIGNMENTを設定するのは主にXMLパーサーのデバック時です(設定しても高速になる可能性はありません)。

XmlStreamWriter.h25 行目に定義があります。

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

データの先頭に識別用の文字列を書きこむかを設定します。

説明
trueならばデータの先頭に$EXIという4バイトのアスキー文字列を書き込みます。
デフォルトはfalseです。

XmlStreamWriter.h23 行目に定義があります。

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

設定の自動認識のための情報を書き込むかを設定します。

説明
trueならばEXIストリームに指定したオプションについての情報が書きこまれます。 読み込みの際にオプションが自動判別されます。
デフォルトはfalseです。

XmlStreamWriter.h24 行目に定義があります。

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

バイナリXMLを書きだすかテキストXMLを書きだすか指定します。

説明
XML_PROCESSOR_EXI にするとバイナリXMLを書き出します。 XML_PROCESSOR_TEXT にするとテキストのXMLを書き出します。
テキストXMLの場合はエンコーディングはutf-8で書き出されます。 オプションは Preserve::pis, Preserve::comments のみが有効となります。 その他のオプションは無視されます。
デフォルトはXML_PROCESSOR_EXI です。

XmlStreamWriter.h29 行目に定義があります。

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

バイナリXMLに記録されるバージョン番号を指定します。

説明
詳細は http://www.w3.org/TR/exi/#version をご覧ください。

XmlStreamWriter.h28 行目に定義があります。


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