Функции пакета
Функции верхнего уровня пакета json, которые можно вызывать напрямую без создания экземпляра Processor. Сгруппированы по функциональности:
Запрос и получение
Функции запросов по пути, типобезопасного получения, безопасного доступа и массового получения.
Основные функции: Get · GetWithContext · GetString · GetInt · GetFloat · GetBool · GetArray · GetObject · GetTyped[T] · SafeGet · GetMultiple
Модификация
Функции установки и объединения JSON-данных.
Основные функции: Set · SetMultiple · SetCreate · SetMultipleCreate · MergeJSON · MergeMany
Операции удаления
Функции удаления узлов JSON-данных.
Основные функции: Delete · DeleteClean
Кодирование и вывод
Функции сериализации, десериализации и потокового кодирования/декодирования.
Основные функции: Marshal · Unmarshal · MarshalIndent · Encode · EncodePretty · EncodeWithConfig · Prettify · Compact · CompactString · Indent · HTMLEscape · NewEncoder · NewDecoder · EncodeBatch · EncodeFields · EncodeStream · SaveToWriter
Парсинг и валидация
Функции парсинга JSON в целевые объекты, парсинга через Processor и валидации JSON / JSON Schema.
Основные функции: Parse · ParseAny · Processor.Parse · Processor.ParseAny · Valid · ValidWithConfig · ValidateSchema
Пакетные операции
Функции пакетной обработки нескольких JSON-операций (get/set/delete/validate).
Основные функции: ProcessBatch · BatchOperation · BatchResult
JSONL
Функции парсинга, потокового чтения, преобразования и записи JSONL (JSON Lines).
Основные функции: ParseJSONL · ToJSONL · ToJSONLString · StreamLinesInto[T] · NewJSONLWriter
Файловый ввод-вывод
Функции чтения/записи файлов и потокового ввода-вывода.
Основные функции: LoadFromFile · LoadFromReader · SaveToFile · MarshalToFile · UnmarshalFromFile · SaveToWriter
Методы итерации
Итерационные функции для обхода JSON-массивов, объектов, вложенных структур и файлов.
Основные функции: Foreach · ForeachWithPath · ForeachNested · ForeachReturn · ForeachWithError · ForeachNestedWithError · ForeachWithPathAndIterator · ForeachWithPathAndControl · ForeachFile · ForeachFileWithPath · ForeachFileChunked · ForeachFileNested
Итерация файлов
Руководство и практика сценариев потоковой итерации файлов (справочник API по функциям уровня пакета ForeachFile* см. в Методы итерации).
Основные функции: ForeachFile · ForeachFileWithPath · ForeachFileChunked · ForeachFileNested
Вспомогательные утилиты
Функции для преобразования типов, сравнения, управления кэшем и обработки ошибок.
Основные функции: CompareJSON · MergeJSON · MergeMany · ClearCache · GetStats · GetHealthStatus · SetGlobalProcessor · ShutdownGlobalProcessor · SafeError · RedactedPath · WarmupCache
Быстрая навигация
| Назначение | Рекомендуемая функция | Документация |
|---|---|---|
| Получение одного значения | GetString, GetInt, GetFloat, GetBool | Запрос и получение |
| Получение любого типа | Get, GetTyped[T] | Запрос и получение |
| Получение с значением по умолчанию | GetString(data, path, "default") | Запрос и получение |
| Обобщённое получение | GetTyped[T](data, path, defaultValue...) | Запрос и получение |
| Массовое получение | GetMultiple | Запрос и получение |
| Модификация JSON | Set, SetCreate | Модификация |
| Удаление JSON | Delete, DeleteClean | Операции удаления |
| Сериализация | Marshal, Encode | Кодирование и вывод |
| Десериализация | Unmarshal, Parse | Кодирование и вывод · Парсинг и валидация |
| Форматирование | Prettify, CompactString, Processor.Compact | Кодирование и вывод |
| Печать вывода | Encode + fmt.Println, EncodePretty | Функции вывода |
| Массовое кодирование | EncodeBatch, EncodeFields, EncodeStream | Массовое кодирование · Вывод процессора |
| Пакетные операции | ProcessBatch | Пакетные операции |
| Валидация | Valid | Парсинг и валидация |
| Валидация JSON Schema | ValidateSchema | Парсинг и валидация |
| Чтение/запись файлов | LoadFromFile, SaveToFile | Файловый ввод-вывод |
| Итерационный обход | Foreach, ForeachWithPath, ForeachNested | Методы итерации |
| Итерация файлов | ForeachFile, ForeachFileChunked | Методы итерации |
| Обработка JSONL | ParseJSONL, ToJSONL | JSONL |
| Сравнение | CompareJSON | Вспомогательные утилиты |
| Объединение | MergeJSON, MergeMany | Модификация |
| Преобразование типов | Методы преобразования типа AccessResult | Вспомогательные утилиты |
| Обработка ошибок | JsonsError, errors.Is | Константы ошибок |
Связанные разделы
- Processor - Методы процессора
- Config - Параметры конфигурации
- Константы и ошибки - Типы ошибок
- Определения интерфейсов - Расширяемые интерфейсы
- Синтаксис выражений пути - Подробное описание синтаксиса пути