QCborMap ¶

概要 ¶

详细描述 ¶

This class can be used to hold an associative container in CBOR, a map between a key and a value type. CBOR is the Concise Binary Object Representation, a very compact form of binary data encoding that is a superset of JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to be used alongside the CoAP protocol .

Unlike JSON and QVariantMap , CBOR map keys can be of any type, not just strings. For that reason, QCborMap is effectively a map between QCborValue keys to QCborValue value elements.

However, for all member functions that take a key parameter, QCborMap provides overloads that will work efficiently with integers and strings. In fact, the use of integer keys is encouraged, since they occupy fewer bytes to transmit and are simpler to encode and decode. Newer protocols designed by the IETF CoRE WG to work specifically with CBOR are known to use them.

QCborMap is not sorted, because of that, searching for keys has linear complexity (O(n)). QCborMap actually keeps the elements in the order that they were inserted, which means that it is possible to make sorted QCborMaps by carefully inserting elements in sorted order. CBOR does not require sorting, but recommends it.

QCborMap can also be converted to and from QVariantMap and QJsonObject . However, when performing the conversion, any non-string keys will be stringified using a one-way method that the conversion back to QCborMap will not undo.

另请参阅

QCborArray QCborValue QJsonDocument QVariantMap

class QCborMap ¶

QCborMap(other)

param other

QCborMap

Constructs an empty CBOR Map object.

另请参阅

isEmpty()

PySide2.QtCore.QCborMap. clear ( ) ¶

Empties this map.

另请参阅

isEmpty()

PySide2.QtCore.QCborMap. compare ( other ) ¶

参数

other – QCborMap

返回类型

int

Compares this map and other , comparing each element in sequence, and returns an integer that indicates whether this map should be sorted prior to (if the result is negative) or after other (if the result is positive). If this function returns 0, the two maps are equal and contain the same elements.

Note that CBOR maps are unordered, which means that two maps containing the very same pairs but in different order will still compare differently. To avoid this, it is recommended to insert elements into the map in a predictable order, such as by ascending key value. In fact, maps with keys in sorted order are required for Canonical CBOR representation.

For more information on CBOR sorting order, see compare() .

另请参阅

compare() compare() operator==()

PySide2.QtCore.QCborMap. contains ( key ) ¶

参数

key – QCborValue

返回类型

bool

PySide2.QtCore.QCborMap. contains ( key ) ¶

参数

key – unicode

返回类型

bool

PySide2.QtCore.QCborMap. contains ( key ) ¶

参数

key – qint64

返回类型

bool

Returns true if this map contains a key-value pair identified by key key . CBOR recommends using integer keys, since they occupy less space and are simpler to encode and decode.

另请参阅

value(qint64) operator[](qint64) find(qint64) remove(qint64) contains(QLatin1String) remove(const QString &) remove(const QCborValue &)

PySide2.QtCore.QCborMap. empty ( ) ¶

返回类型

bool

同义词为 isEmpty() . This function is provided for compatibility with generic code that uses the Standard Library API.

Returns true if this map is empty ( size() == 0).

另请参阅

isEmpty() size()

static PySide2.QtCore.QCborMap. fromJsonObject ( o ) ¶

参数

o – QJsonObject

返回类型

QCborMap

Converts all JSON items found in the obj object to CBOR using QCborValue::fromJson(), and returns the map composed of those elements.

This conversion is lossless, as the CBOR type system is a superset of JSON’s. Moreover, the map returned by this function can be converted back to the original obj by using toJsonObject() .

另请参阅

toJsonObject() toVariantMap() fromJsonValue() fromJsonArray()

static PySide2.QtCore.QCborMap. fromVariantHash ( hash ) ¶

参数

hash –

返回类型

QCborMap

Converts all the items in hash to CBOR using fromVariant() and returns the map composed of those elements.

Conversion from QVariant is not completely lossless. Please see the documentation in fromVariant() 了解更多信息。

另请参阅

toVariantHash() fromVariantMap() fromJsonObject() fromVariant()

static PySide2.QtCore.QCborMap. fromVariantMap ( map ) ¶

参数

map –

返回类型

QCborMap

Converts all the items in map to CBOR using fromVariant() and returns the map composed of those elements.

Conversion from QVariant is not completely lossless. Please see the documentation in fromVariant() 了解更多信息。

另请参阅

toVariantMap() fromVariantHash() fromJsonObject() fromVariant()

PySide2.QtCore.QCborMap. isEmpty ( ) ¶

返回类型

bool

Returns true if this map is empty (that is, size() is 0).

另请参阅

size() clear()

PySide2.QtCore.QCborMap. keys ( ) ¶

返回类型

Returns a list of all keys in this map.

另请参阅

keys() keys()

PySide2.QtCore.QCborMap. __ne__ ( other ) ¶

参数

other – QCborMap

返回类型

bool

Compares this map and other , comparing each element in sequence, and returns true if the two maps contains any different elements or elements in different orders, false otherwise.

Note that CBOR maps are unordered, which means that two maps containing the very same pairs but in different order will still compare differently. To avoid this, it is recommended to insert elements into the map in a predictable order, such as by ascending key value. In fact, maps with keys in sorted order are required for Canonical CBOR representation.

For more information on CBOR equality in Qt, see, compare() .

另请参阅

compare() operator==() operator==() operator==() operator

PySide2.QtCore.QCborMap. __lt__ ( other ) ¶

参数

other – QCborMap

返回类型

bool

PySide2.QtCore.QCborMap. __eq__ ( other ) ¶

参数

other – QCborMap

返回类型

bool

Compares this map and other , comparing each element in sequence, and returns true if the two maps contains the same elements in the same order, false otherwise.

Note that CBOR maps are unordered, which means that two maps containing the very same pairs but in different order will still compare differently. To avoid this, it is recommended to insert elements into the map in a predictable order, such as by ascending key value. In fact, maps with keys in sorted order are required for Canonical CBOR representation.

For more information on CBOR equality in Qt, see, compare() .

另请参阅

compare() operator==() operator!=() operator

PySide2.QtCore.QCborMap.operator[](key)

参数

key – QCborValue

返回类型

QCborValue

PySide2.QtCore.QCborMap.operator[](key)

参数

key – qint64

返回类型

QCborValue

返回 QCborValue element in this map that corresponds to key key , if there is one. CBOR recommends using integer keys, since they occupy less space and are simpler to encode and decode.

If the map does not contain key key , this function returns a QCborValue containing an undefined value. For that reason, it is not possible with this function to tell apart the situation where the key was not present from the situation where the key was mapped to an undefined value.

If the map contains more than one key equal to key , it is undefined which one this function will return. QCborMap does not allow inserting duplicate keys, but it is possible to create such a map by decoding a CBOR stream with them. They are usually not permitted and having duplicate keys is usually an indication of a problem in the sender.

operator[]( QLatin1String ), operator[](const QString &), operator[](const QCborOperator[] &)

另请参阅

value(qint64) find(qint64) constFind(qint64) remove(qint64) contains(qint64)

PySide2.QtCore.QCborMap.operator[](key)

参数

key – unicode

返回类型

QCborValue

PySide2.QtCore.QCborMap. remove ( key ) ¶

参数

key – QCborValue

PySide2.QtCore.QCborMap. remove ( key ) ¶

参数

key – unicode

PySide2.QtCore.QCborMap. remove ( key ) ¶

参数

key – qint64

Removes the key key and the corresponding value from the map, if it is found. If the map contains no such key, this function does nothing.

If the map contains more than one key equal to key , it is undefined which one this function will remove. QCborMap does not allow inserting duplicate keys, but it is possible to create such a map by decoding a CBOR stream with them. They are usually not permitted and having duplicate keys is usually an indication of a problem in the sender.

remove( QLatin1String ), remove(const QString &), remove(const QCborValue &)

另请参阅

value(qint64) operator[](qint64) find(qint64) contains(qint64)

PySide2.QtCore.QCborMap. size ( ) ¶

返回类型

long long

Returns the number of elements in this map.

另请参阅

isEmpty()

PySide2.QtCore.QCborMap. swap ( other ) ¶

参数

other – QCborMap

Swaps the contents of this map and other .

PySide2.QtCore.QCborMap. take ( key ) ¶

参数

key – QCborValue

返回类型

QCborValue

PySide2.QtCore.QCborMap. take ( key ) ¶

参数

key – unicode

返回类型

QCborValue

PySide2.QtCore.QCborMap. take ( key ) ¶

参数

key – qint64

返回类型

QCborValue

Removes the key key and the corresponding value from the map and returns the value, if it is found. If the map contains no such key, this function does nothing.

If the map contains more than one key equal to key , it is undefined which one this function will remove. QCborMap does not allow inserting duplicate keys, but it is possible to create such a map by decoding a CBOR stream with them. They are usually not permitted and having duplicate keys is usually an indication of a problem in the sender.

另请参阅

value(qint64) operator[](qint64) find(qint64) contains(qint64) take(QLatin1String) take(const QString &) take(const QCborValue &) insert()

PySide2.QtCore.QCborMap. toCborValue ( ) ¶

返回类型

QCborValue

Explicitly constructs a QCborValue object that represents this map. This function is usually not necessary since QCborValue has a constructor for QCborMap , so the conversion is implicit.

转换 QCborMap to QCborValue allows it to be used in any context where QCborValues can be used, including as keys and mapped types in QCborMap , as well as toCbor() .

另请参阅

QCborValue(const QCborMap &)

PySide2.QtCore.QCborMap. toJsonObject ( ) ¶

返回类型

QJsonObject

Recursively converts every QCborValue value in this map to JSON using toJsonValue() and creates a string key for all keys that aren’t strings, then returns the corresponding QJsonObject composed of those associations.

Please note that CBOR contains a richer and wider type set than JSON, so some information may be lost in this conversion. For more details on what conversions are applied, see toJsonValue() .