JSONのジェネレータです。MpObject
をJSONに変換してストリームに書き出します。
[詳解]
#include "nn/nlib/msgpack/JsonWriter.h"
|
static bool | Write (char *str, size_t n, const MpObject &obj, uint32_t option=0) noexcept |
| obj をJSONに変換して、メモリストリーム経由でstr に書き込みます。 [詳解]
|
|
template<size_t n> |
static bool | Write (char(&str)[n], const MpObject &obj, uint32_t option=0) noexcept |
| obj をJSONに変換して、メモリストリーム経由でstr に書き込みます。 [詳解]
|
|
JSONのジェネレータです。MpObject
をJSONに変換してストリームに書き出します。
JsonWriter.h の 18 行目に定義があります。
Write()
に渡すことのできるオプション値が定義されています。
列挙値 |
---|
OPTION_DEFAULT |
デフォルトの設定です。
|
OPTION_RELAXED |
JSONは本来配列か連想配列である必要がありますが、その規則を緩めて解釈します。 例えば数値や文字列のみ、といった厳密にはJSONでない文字列を書き込むことを可能にしたい場合に指定します。
|
JsonWriter.h の 20 行目に定義があります。
nn::nlib::msgpack::JsonWriter::Close |
( |
| ) |
|
|
noexcept |
JsonWriter
をクローズします。
- 戻り値
- 成功した場合は
true
- 説明
JsonWriter
をクローズして、ベースストリームをデタッチします。 この際、ベースストリームはクローズされません。
Init()
メンバ関数を再び利用することでオブジェクトを再利用することができます。
nn::nlib::msgpack::JsonWriter::Flush |
( |
| ) |
|
|
noexcept |
ベースとなる書き込みストリームをフラッシュします。
- 戻り値
- 成功した場合は
true
nn::nlib::msgpack::JsonWriter::GetErrorValue |
( |
| ) |
const |
|
inlinenoexcept |
発生したエラーを取得します。
- 戻り値
-
0 | エラーは発生していません。 |
EILSEQ | MpObject がJSONに変換できる形式ではない。 |
EINVAL | 引数にエラーがあった。 |
EEXIST | 初期化されたJsonWriter を再度初期化しようとした。 |
EIO | ベースストリームでエラーが発生した。 |
EBADF | 未初期化のJsonWriter を利用しようとした。 |
ENOMEM | メモリの取得に失敗した。 |
JsonWriter.h の 29 行目に定義があります。
nn::nlib::msgpack::JsonWriter::GetStream |
( |
| ) |
|
|
inlinenoexcept |
nn::nlib::msgpack::JsonWriter::Init |
( |
OutputStream * |
stream | ) |
|
|
noexcept |
JsonWriter を初期化します。失敗した場合はエラーを設定してfalse
を返します。
- 引数
-
- 戻り値
- 成功した場合は
true
nn::nlib::msgpack::JsonWriter::Write |
( |
const MpObject & |
obj, |
|
|
uint32_t |
option = 0 |
|
) |
| |
|
noexcept |
MpObject
をJSONに変換してストリームに書き出します。
- 引数
-
- 戻り値
- 成功した場合は
true
- 説明
MpObject
をJSONに変換してストリームに書き出します。 成功した場合はtrue
を返します。失敗した場合はエラーを設定しfalse
を返します。
nn::nlib::msgpack::JsonWriter::Write |
( |
char * |
str, |
|
|
size_t |
n, |
|
|
const MpObject & |
obj, |
|
|
uint32_t |
option = 0 |
|
) |
| |
|
staticnoexcept |
obj
をJSONに変換して、メモリストリーム経由でstr
に書き込みます。
- 引数
-
[out] | str | JSON文字列が格納される領域へのポインタ |
[in] | n | str のサイズ |
[in] | obj | JSONに変換するオブジェクト |
[in] | option | オプション。JsonWriter::Option 型の値を論理和で合成した値を与えます。 |
- 戻り値
- 成功した場合は
true
template<size_t n>
nn::nlib::msgpack::JsonWriter::Write |
( |
char(&) |
str[n], |
|
|
const MpObject & |
obj, |
|
|
uint32_t |
option = 0 |
|
) |
| |
|
inlinestaticnoexcept |
obj
をJSONに変換して、メモリストリーム経由でstr
に書き込みます。
- テンプレート引数
-
- 引数
-
[out] | str | JSON文字列が格納される領域へのポインタ |
[in] | obj | JSONに変換するオブジェクト |
[in] | option | オプション。JsonWriter::Option 型の値を論理和で合成した値を与えます。 |
- 戻り値
- 成功した場合は
true
JsonWriter.h の 38 行目に定義があります。
このクラス詳解は次のファイルから抽出されました: