nlib
|
JSON SchemaをJsonSchemaValidator
で利用できるバイトコード形式に変換します。
[詳解]
#include "nn/nlib/msgpack/JsonSchema.h"
クラス | |
struct | Detail |
JSON Schemaの変換に失敗した場合、path というメンバに変換に失敗した場所についての文字列が書き込まれます。 [詳解] | |
公開型 | |
enum | Result { kOk = 0, kInvalidParam, kAlreadyInitialized, kOutOfMemory, kInvalidSchema, kFileNotFound, kIoError, kUriError, kBufferSizeNotEnough } |
関数の実行結果です。 [詳解] | |
公開メンバ関数 | |
constexpr | JsonSchemaConverter () noexcept |
デフォルトコンストラクタです。 | |
~JsonSchemaConverter () noexcept | |
デストラクタです。 | |
Result | Init (const JsonSchemaConverterSettings &settings) noexcept |
オブジェクトを初期化します。 [詳解] | |
Result | Init () noexcept |
JsonSchemaConverterSettings をデフォルトにして初期化します。 | |
void | Reset () noexcept |
オブジェクトをデフォルトコンストラクタの実行後と同じ状態に設定します。 | |
Result | Convert (const char *uri, Detail *detail) noexcept |
JSON SchemaをJsonSchemaValidatorが利用できる形式に変換します。 [詳解] | |
Result | Convert (MpObject *schema, Detail *detail) noexcept |
JSON SchemaをJsonSchemaValidatorが利用できる形式に変換します。 [詳解] | |
Result | Export (size_t *written, nlib_byte_t *buf, size_t bufsize) const noexcept |
バイトコードに変換したJSON Schemaを書き込みます。 [詳解] | |
template<size_t N> | |
Result | Export (size_t *written, nlib_byte_t(&buf)[N]) const noexcept |
バイトコードに変換したJSON Schemaを書き込みます。 [詳解] | |
JSON SchemaをJsonSchemaValidator
で利用できるバイトコード形式に変換します。
JsonSchemaValidator
の説明を参照してください。 JsonSchema.h の 70 行目に定義があります。
関数の実行結果です。
JsonSchema.h の 72 行目に定義があります。
|
noexcept |
JSON SchemaをJsonSchemaValidatorが利用できる形式に変換します。
[in] | uri | JSON SchemaとなるJSONを指し示す絶対URI |
[in] | detail | NULL でない場合は、エラーが発生した場合の追加情報を得ることができます。 |
kOk | 変換が成功した場合 |
kOutOfMemory | メモリの確保に失敗した場合 |
kInvalidSchema | スキーマが無効だった場合 |
kFileNotFound | 読み込むファイルが存在しなかった場合 |
kIoError | ファイルの読み取りが失敗した場合 |
kUriError | 無効なURIが見つかった場合やuri が相対URIだった場合 |
uri
で参照されるJSON Schemaを変換します。 また、URIから実際のファイルパスへの変換はJsonSchemaConverterSettings::uri_mapper
を利用して行われます。 uri
がNULL
の場合は、"nlibpath:///jsonschema/schema.json"であるものとして解釈されます。 JSON SchemaをJsonSchemaValidatorが利用できる形式に変換します。
[in,out] | schema | 変換されるJSON Schema。内部の値が変更されうることに注意してください。 |
[in] | detail | NULL でない場合は、エラーが発生した場合の追加情報を得ることができます。 |
kOk | 変換が成功した場合 |
kOutOfMemory | メモリの確保に失敗した場合 |
kInvalidParam | schema がNULL だった場合 |
kInvalidSchema | スキーマが無効だった場合 |
kFileNotFound | 読み込むファイルが存在しなかった場合 |
kIoError | ファイルの読み取りが失敗した場合 |
kUriError | 無効なURIが見つかった場合 |
|
noexcept |
バイトコードに変換したJSON Schemaを書き込みます。
[out] | written | 書き込まれたバイト数 |
[out] | buf | データが書き込まれるバッファ |
[in] | bufsize | バッファ・サイズ |
0 | 成功した場合 |
kInvalidParam | written 又はbuf がNULL だった場合 |
kOutOfMemory | メモリの確保に失敗した場合 |
kBufferSizeNotEnough | バッファ・サイズが十分でなかった場合 |
JsonSchemaValidator::Init()
に渡して検証に利用することができます。
|
inlinenoexcept |
バイトコードに変換したJSON Schemaを書き込みます。
N | バッファ・サイズ |
[out] | written | 書き込まれたバイト数 |
[out] | buf | データが書き込まれるバッファ |
0 | 成功した場合 |
kOutOfMemory | メモリの確保に失敗した場合 |
kBufferSizeNotEnough | バッファ・サイズが十分でなかった場合 |
JsonSchema.h の 99 行目に定義があります。
|
noexcept |
オブジェクトを初期化します。
[in] | settings | 変換オプションを指定するための構造体 |
kOk | 成功した場合 |
kAlreadyInitialized | 既にオブジェクトが初期化済みだった場合 |
kOutOfMemory | メモリの確保に失敗した場合 |
© 2012-2017 Nintendo Co., Ltd. All rights reserved.