Spec-Zone.ru › Qt 6.0

Класс QJsonValue

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

Заголовок: #include <QJsonValue>
CMake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
С момента: Qt 5.0
  • Список всех членов, включая наследуемые

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

Публичные типы

Перечисление Тип { Null, Bool, Double, String, Array, …, Undefined }

Публичные функции

QJsonValue(QJsonValue &&other)
QJsonValue(const QJsonValue &other)
QJsonValue(const QJsonObject &o)
QJsonValue(const QJsonArray &a)
QJsonValue(const char *s)
QJsonValue(QLatin1String s)
QJsonValue(const QString &s)
QJsonValue(qint64 v)
QJsonValue(int v)
QJsonValue(double v)
QJsonValue(bool b)
QJsonValue(QJsonValue::Type type = Null)
QJsonValue & operator=(QJsonValue &&other)
QJsonValue & operator=(const QJsonValue &other)
~QJsonValue()
bool isArray() const
bool isBool() const
bool isDouble() const
bool isNull() const
bool isObject() const
bool isString() const
bool isUndefined() const
void swap(QJsonValue &other)
QJsonArray toArray(const QJsonArray &defaultValue) const
QJsonArray toArray() const
bool toBool(bool defaultValue = false) const
double toDouble(double defaultValue = 0) const
int toInt(int defaultValue = 0) const
qint64 toInteger(qint64 defaultValue = 0) const
QJsonObject toObject(const QJsonObject &defaultValue) const
QJsonObject toObject() const
QString toString() const
QString toString(const QString &defaultValue) const
QVariant toVariant() const
QJsonValue::Type type() const
bool operator!=(const QJsonValue &other) const
bool operator==(const QJsonValue &other) const
const QJsonValue operator[](const QString &key) const
const QJsonValue operator[](QStringView key) const
const QJsonValue operator[](QLatin1String key) const
const QJsonValue operator[](qsizetype i) const

Статические публичные члены

QJsonValue fromVariant(const QVariant &variant)

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

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

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

  • bool QJsonValue::Bool
  • double QJsonValue::Double
  • строка QJsonValue::String
  • массив QJsonValue::Array
  • объект 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.

Константа Значение Описание
QJsonValue::Null 0x0 Значение Null
QJsonValue::Bool 0x1 Булево значение. Используйте toBool() для преобразования в bool.
QJsonValue::Double 0x2 Числовое значение. Используйте toDouble() для преобразования в double или toInteger() для преобразования в qint64.
QJsonValue::String 0x3 Строка. Используйте toString() для преобразования в QString.
QJsonValue::Array 0x4 Массив. Используйте toArray() для преобразования в QJsonArray.
QJsonValue::Object 0x5 Объект. Используйте toObject() для преобразования в QJsonObject.
QJsonValue::Undefined 0x80 Значение не определено. Обычно возвращается как ошибка, при попытке получить значение по индексу вне границ массива или несуществующего ключа в объекте.

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

[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)

Создаёт значение типа Массив со значением a.

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

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

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

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

QJsonValue::QJsonValue(QLatin1String s)

Создаёт значение типа Строка со значением s.

QJsonValue::QJsonValue(const QString &s)

Создаёт значение типа Строка со значением 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:

Исходный тип Целевой тип
  • QMetaType::Nullptr
QJsonValue::Null
  • QMetaType::Bool
QJsonValue::Bool
  • QMetaType::Int
  • QMetaType::UInt
  • QMetaType::LongLong
  • QMetaType::ULongLong
  • QMetaType::Float
  • QMetaType::Double
QJsonValue::Double
  • QMetaType::QString
QJsonValue::String
  • QMetaType::QStringList
  • QMetaType::QVariantList
QJsonValue::Array
  • QMetaType::QVariantMap
  • QMetaType::QVariantHash
QJsonValue::Object
  • QMetaType::QUrl
QJsonValue::String. Преобразование будет использовать QUrl::toString() с флагом QUrl::FullyEncoded, чтобы обеспечить максимальную совместимость при разборе URL-адреса
  • QMetaType::QUuid
QJsonValue::String. Начиная с Qt 5.11, результирующая строка не будет содержать фигурных скобок
  • QMetaType::QCborValue
Любой тип, который возвращает QCborValue::toJsonValue().
  • QMetaType::QCborArray
QJsonValue::Array. См. QCborValue::toJsonValue() для ограничений преобразования.
  • QMetaType::QCborMap
QJsonValue::Map. См. QCborValue::toJsonValue() для ограничений преобразования и "строкового" представления ключей словаря.
Потеря информации и другие типы

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

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

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

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

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

END_OF_DOCUMENT_MARKER

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

bool QJsonValue::isArray() const

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

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

bool QJsonValue::isBool() const

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

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

bool QJsonValue::isDouble() const

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

См. также 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() не Object, возвращается defaultValue.

QJsonObject QJsonValue::toObject() const

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

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

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

QString QJsonValue::toString() const

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

Если type() не String, возвращается null QString.

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

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

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

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

QVariant QJsonValue::toVariant() const

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

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

Константа Описание
Null QMetaType::Nullptr
Bool QMetaType::Bool
Double QMetaType::Double или QMetaType::LongLong
String QString
Array QVariantList
Object QVariantMap
Undefined QVariant()

См. также 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.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qjsonvalue.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API