PMEMKV_JSON_CONFIG

Тип содержимого: «text/css»

Заголовок: _MP(PMEMKV_JSON_CONFIG, 3)

Коллекция: libpmemkv

Заголовок: PMEMKV_JSON_CONFIG

Вторичный заголовок: pmemkv_json_config

…

комментарий: <> (libpmemkv_json_config.3 — man-страница для конфигурационного API libpmemkv_json_config).

ИМЯ

pmemkv_json_config — вспомогательный конфигурационный API для libpmemkv.

СИНТАКСИС

#include <libpmemkv_json_config.h>

int pmemkv_config_from_json(pmemkv_config *config, const char *jsonconfig);
const char *pmemkv_config_from_json_errormsg(void);

Общее описание pmemkv и доступных движков см. в libpmemkv(7). Описание основного API pmemkv см. в libpmemkv(3). Описание конфигурационного API для libpmemkv см. в libpmemkv_config(3).

ОПИСАНИЕ

pmemkv_json_config — это вспомогательная библиотека, которая предоставляет две функции:

int pmemkv_config_from_json(pmemkv_config *config, const char *jsonconfig);

: анализирует строку JSON и помещает все найденные элементы в JSON в config. Разрешённые типы в строках JSON и соответствующие им типы в pmemkv_config:

• число — int64 или uint64;
• строка — const char *;
• объект — (другая строка JSON) → указатель на pmemkv_config (можно получить с помощью pmemkv_config_get_object);
• True, False — int64.

const char *pmemkv_config_from_json_errormsg(void);

: возвращает удобочитаемую строку, описывающую последнюю ошибку.

Функция 'pmemkv_config_from_json' зависит от библиотеки RapidJSON, что является непосредственной причиной создания этой небольшой библиотеки.

Сборка этой библиотеки включена по умолчанию. Её можно отключить, установив переменную CMake BUILD_JSON_CONFIG в OFF:

cmake .. -DBUILD_JSON_CONFIG=OFF

ОШИБКИ

Функция pmemkv_config_from_json() возвращает статус. Возможные возвращаемые значения:

• PMEMKV_STATUS_OK — ошибок нет;
• PMEMKV_STATUS_UNKNOWN_ERROR — неизвестная ошибка;
• PMEMKV_STATUS_CONFIG_PARSING_ERROR — ошибка при анализе данных конфигурации.

ПРИМЕР

Пример можно найти в libpmemkv_config(3).

СМОТРИТЕ ТАКЖЕ

libpmemkv(7), libpmemkv(3), libpmemkv_config(3) и https://pmem.io