Справочник API
Этот раздел содержит полный справочник API библиотеки github.com/cybergodev/json.
Индекс модулей
| Модуль | Описание |
|---|---|
| Функции пакета | Справочник функций уровня пакета, включая запросы по пути, получение типов, кодирование/декодирование |
| Processor | Методы и настройки обработчика |
| Config | Подробное описание параметров конфигурации |
| Определения типов | Основные определения типов (включая Encoder/Decoder) |
| Обобщённые операции | Справочник обобщённых API |
| Определения интерфейсов | Определения расширяемых интерфейсов |
| Потоковая обработка | Справочник потоковых обработчиков |
| Обработка NDJSON | Обработчик JSONL/NDJSON |
| Итератор | API итеративного обхода |
| Вспомогательные функции | Функции преобразования типов и утилиты |
| Форматированный вывод | Форматирование и красивый вывод |
| Проверка безопасности | API, связанное с безопасностью |
| Валидатор | Валидатор схем Schema |
| Система перехватчиков | Перехватчики операций |
| Пользовательский кодировщик | Пользовательский кодировщик |
| Константы и ошибки | Константы и типы ошибок |
Быстрый поиск
Классификация по функциональности
Запросы по пути
| Функция | Описание |
|---|---|
Get, GetString, GetInt, GetFloat, GetBool, GetArray, GetObject | Типобезопасное получение |
GetTyped[T] | Обобщённое получение |
SafeGet | Безопасное получение AccessResult |
GetMultiple | Пакетное получение |
Операции модификации
| Функция | Описание |
|---|---|
Set, SetMultiple | Установка значений |
SetCreate, SetMultipleCreate | Установка значений с автоматическим созданием пути |
Delete, DeleteClean | Удаление значений |
ProcessBatch | Пакетные операции |
Кодирование/декодирование
| Функция | Описание |
|---|---|
Marshal, Unmarshal | Стандартное кодирование/декодирование |
MarshalIndent | Форматированное кодирование |
Encode, EncodeWithConfig | Кодирование в строку |
NewEncoder, NewDecoder | Потоковое кодирование/декодирование |
Parse | Разбор JSON |
Форматирование
| Функция | Описание |
|---|---|
Prettify | Форматирование JSON |
Compact | Сжатие JSON |
Файловые операции
| Функция | Описание |
|---|---|
LoadFromFile, SaveToFile | Чтение/запись файлов |
LoadFromReader | Чтение из Reader |
MarshalToFile, UnmarshalFromFile | Кодирование/декодирование файлов |
Потоковая обработка
| Тип/Метод | Описание |
|---|---|
ForeachFile | Потоковая обработка файлов |
NDJSONProcessor | Обработчик NDJSON/JSONL |
JSONLWriter | Записыватель JSONL |
Валидация
| Функция | Описание |
|---|---|
Valid | Проверка JSON |
ValidateSchema | Валидация Schema (используется с типом Schema) |
Соглашения об именовании
Библиотека следует следующим соглашениям об именовании:
| Шаблон | Описание | Пример |
|---|---|---|
Get{Type} | Получение указанного типа (поддерживает defaultValue) | GetString, GetInt |
GetTyped[T] | Обобщённое получение, возвращает T | GetTyped[User] |
New{Type} | Создание экземпляра | New (возвращает *Processor), NewEncoder |
Default{Type} | Конфигурация по умолчанию | DefaultConfig |
{Type}Config | Предустановка конфигурации | SecurityConfig, PrettyConfig |
Связанные разделы
- Быстрый старт -- Установка и базовое использование
- Синтаксис выражений пути -- Синтаксис запросов по пути
- Примеры использования -- Практические примеры кода
- Обработка больших файлов -- Руководство по потоковой обработке