Класс QJsonValue

Класс QJsonValue инкапсулирует значение в формате JSON. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Типы Public

Функции Public

Статические члены Public

Подробное описание

Значение в формате JSON может быть одного из 6 основных типов:

JSON — это формат для хранения структурированных данных. Он имеет 6 основных типов данных:

• bool QJsonValue::Bool
• double QJsonValue::Double
• string QJsonValue::String
• array QJsonValue::Array
• object QJsonValue::Object
• null QJsonValue::Null

Значение может представлять любой из вышеперечисленных типов данных. Кроме того, QJsonValue имеет один специальный флаг для представления неопределенных значений. Это можно запросить с помощью isUndefined().

Тип значения можно запросить с помощью type() или методов-аксессоров, таких как isBool(), isString() и так далее. Аналогично, значение можно преобразовать в тип, хранящийся в нём, используя toBool(), toString() и так далее.

Значения строго типизированы внутри и, в отличие от QVariant, не будут пытаться выполнить неявные преобразования типов. Это означает, что преобразование в тип, который не хранится в значении, вернёт значение по умолчанию.

QJsonValueRef

QJsonValueRef — это вспомогательный класс для QJsonArray и QJsonObject. Когда вы получаете объект типа QJsonValueRef, вы можете использовать его так, как будто это ссылка на QJsonValue. Если вы присваиваете значение, присваивание будет применено к элементу в QJsonArray или QJsonObject, из которого вы получили ссылку.

Следующие методы возвращают QJsonValueRef:

• QJsonArray::operator[](qsizetype i)
• QJsonObject::operator[](const QString & key) const

См. также Поддержка JSON в Qt и Пример сохранения игры в формате JSON.

Документация по типам членов

enum QJsonValue::Type

Этот перечисление описывает тип значения JSON.

Документация по функциям-членам

[since 5.10] QJsonValue::QJsonValue(QJsonValue &&other)

Создает QJsonValue, используя перемещение данных из other.

Эта функция была добавлена в Qt 5.10.

QJsonValue::QJsonValue(const QJsonValue &other)

Создает копию other.

QJsonValue::QJsonValue(const QJsonObject &o)

Создает значение типа Object со значением o.

QJsonValue::QJsonValue(const QJsonArray &a)

Создает значение типа Array со значением a.

[since 5.3] QJsonValue::QJsonValue(const char *s)

Создаёт значение типа String со значением s, предполагая кодировку UTF-8 входных данных.

Вы можете отключить этот конструктор, определив QT_NO_CAST_FROM_ASCII при компиляции вашего приложения.

Эта функция была добавлена в Qt 5.3.

QJsonValue::QJsonValue(QLatin1String s)

Создает значение типа String со значением s.

QJsonValue::QJsonValue(const QString &s)

Создает значение типа String со значением s.

QJsonValue::QJsonValue(qint64 v)

Это перегруженная функция.

Создаёт значение типа Double со значением v. ПРИМЕЧАНИЕ: пределы целых чисел для данных двойной точности IEEE 754 составляют 2^53 (-9007199254740992 до +9007199254740992). Если вы передадите значения вне этого диапазона, ожидайте потерь точности.

QJsonValue::QJsonValue(int v)

Это перегруженная функция.

Создаёт значение типа Double со значением v.

QJsonValue::QJsonValue(double v)

Создает значение типа Double со значением v.

QJsonValue::QJsonValue(bool b)

Создаёт значение типа Bool со значением b.

QJsonValue::QJsonValue(QJsonValue::Type type = Null)

Создает QJsonValue заданного типа type.

По умолчанию создаётся значение Null.

[since 5.10] QJsonValue &QJsonValue::operator=(QJsonValue &&other)

Присваивает other этому значению посредством перемещения.

Эта функция была добавлена в Qt 5.10.

QJsonValue &QJsonValue::operator=(const QJsonValue &other)

Присваивает значение, хранящееся в other, этому объекту.

QJsonValue::~QJsonValue()

Уничтожает значение.

[static] QJsonValue QJsonValue::fromVariant(const QVariant &variant)

Преобразует variant в QJsonValue и возвращает его.

Преобразование будет осуществляться следующим образом для типов QVariant:

Потеря информации и другие типы

QVariant может содержать больше информации, чем может быть представлено в JSON. Если QVariant не относится к одному из перечисленных выше типов, преобразование не гарантировано и может быть изменено в будущих версиях Qt, как это произошло с UUID. Код должен стремиться не использовать типы, не указанные в списке выше.

Если QVariant::isNull() возвращает true, возвращается или вставляется нулевое QJsonValue в список или объект, независимо от типа, хранящегося в QVariant. Обратите внимание на изменение поведения в Qt 6.0, влияющее на QVariant::isNull(), которое также влияет на эту функцию.

Вещественное значение, являющееся бесконечностью или NaN, будет преобразовано в нулевое значение JSON. Начиная с Qt 6.0, QJsonValue может хранить полную точность любого 64-битного целого числа со знаком без потерь, но в предыдущих версиях значения за пределами диапазона ±2^53 могут потерять точность. Беззнаковые 64-битные значения, большие или равные 2^63, либо потеряют точность, либо станут эквивалентны отрицательным значениям, поэтому QMetaType::ULongLong следует избегать.

Для других типов, не перечисленных выше, будет предпринята попытка преобразования в строку, обычно, но не всегда, вызывая QVariant::toString(). Если преобразование не удаётся, значение заменяется нулевым значением JSON. Обратите внимание, что QVariant::toString() также приводит к потерям точности для большинства типов. Например, если переданный QVariant представляет данные необработанного байтового массива, рекомендуется предварительно закодировать его в Base64 (или другую без потерь кодировку), в противном случае будет использоваться потерянное преобразование с помощью QString::fromUtf8().

Обратите внимание, что преобразования через QVariant::toString() могут быть изменены в любое время. Как QVariant, так и QJsonValue могут быть расширены в будущем для поддержки большего количества типов, что приведёт к изменению способа работы этой функции.

См. также toVariant() и QCborValue::fromVariant().

bool QJsonValue::isArray() const

Возвращает true если значение содержит массив.

См. также toArray().

bool QJsonValue::isBool() const

Возвращает true если значение содержит булево значение.

См. также toBool().

bool QJsonValue::isDouble() const

Возвращает true если значение содержит двойное значение.

См. также toDouble().

bool QJsonValue::isNull() const

Возвращает true если значение равно null.

bool QJsonValue::isObject() const

Возвращает true если значение содержит объект.

См. также toObject().

bool QJsonValue::isString() const

Возвращает true если значение содержит строку.

См. также toString().

bool QJsonValue::isUndefined() const

Возвращает true если значение не определено. Это может произойти в некоторых случаях ошибок, например, при обращении к несуществующему ключу в QJsonObject.

[since 5.10] void QJsonValue::swap(QJsonValue &other)

Меняет значения other с этим. Эта операция очень быстрая и никогда не терпит неудачу.

Эта функция была добавлена в Qt 5.10.

QJsonArray QJsonValue::toArray(const QJsonArray &defaultValue) const

Преобразует значение в массив и возвращает его.

Если type() не является массивом, возвращается defaultValue.

QJsonArray QJsonValue::toArray() const

Это перегруженная функция.

Преобразует значение в массив и возвращает его.

Если type() не является массивом, возвращается QJsonArray().

bool QJsonValue::toBool(bool defaultValue = false) const

Преобразует значение в bool и возвращает его.

Если type() не является bool, возвращается defaultValue.

double QJsonValue::toDouble(double defaultValue = 0) const

Преобразует значение в double и возвращает его.

Если type() не является Double, возвращается defaultValue.

[since 5.2] int QJsonValue::toInt(int defaultValue = 0) const

Преобразует значение в int и возвращает его.

Если type() не является Double или значение не является целым числом, возвращается defaultValue.

Эта функция была добавлена в Qt 5.2.

[since 6.0] qint64 QJsonValue::toInteger(qint64 defaultValue = 0) const

Преобразует значение в целое число и возвращает его.

Если type() не является Double или значение не является целым числом, представимым как qint64, возвращается defaultValue.

Эта функция была добавлена в Qt 6.0.

QJsonObject QJsonValue::toObject(const QJsonObject &defaultValue) const

Преобразует значение в объект и возвращает его.

Если type() не является объектом, возвращается defaultValue.

QJsonObject QJsonValue::toObject() const

Это перегруженная функция.

Преобразует значение в объект и возвращает его.

Если type() не является объектом, возвращается QJsonObject().

QString QJsonValue::toString() const

Преобразует значение в QString и возвращает его.

Если type() не является строкой, возвращается пустая QString.

См. также QString::isNull().

QString QJsonValue::toString(const QString &defaultValue) const

Преобразует значение в QString и возвращает его.

Если type() не является строкой, возвращается defaultValue.

QVariant QJsonValue::toVariant() const

Преобразует значение в QVariant().

Типы QJsonValue будут преобразованы следующим образом:

См. также fromVariant().

QJsonValue::Type QJsonValue::type() const

Возвращает тип значения.

См. также QJsonValue::Type.

bool QJsonValue::operator!=(const QJsonValue &other) const

Возвращает true если значение не равно other.

bool QJsonValue::operator==(const QJsonValue &other) const

Возвращает true если значение равно other.

[since 5.10] const QJsonValue QJsonValue::operator[](const QString &key) const

Возвращает QJsonValue, представляющую значение для ключа key.

Эквивалентно вызову toObject().value(key).

Возвращаемое QJsonValue равно QJsonValue::Undefined, если ключ не существует или если isObject() равно false.

Эта функция была добавлена в Qt 5.10.

См. также QJsonValue, QJsonValue::isUndefined() и QJsonObject.

[since 5.14] const QJsonValue QJsonValue::operator[](QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

[since 5.10] const QJsonValue QJsonValue::operator[](QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.10.

[since 5.10] const QJsonValue QJsonValue::operator[](qsizetype i) const

Возвращает QJsonValue, представляющую значение для индекса i.

Эквивалентно вызову toArray().at(i).

Возвращаемое QJsonValue равно QJsonValue::Undefined, если i выходит за пределы диапазона или если isArray() равно false.

Эта функция была добавлена в Qt 5.10.

См. также QJsonValue, QJsonValue::isUndefined() и QJsonArray.