En esta página

QCborStreamReader Class

La clase QCborStreamReader es un sencillo decodificador de flujos CBOR que funciona tanto con un « QByteArray » como con un « QIODevice ». Más información...

Encabezado: #include <QCborStreamReader>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

struct StringResult
enum StringResultCode { EndOfString, Ok, Error }
enum Type { UnsignedInteger, NegativeInteger, ByteArray, ByteString, String, …, Invalid }

Funciones públicas

QCborStreamReader()
QCborStreamReader(QIODevice *device)
QCborStreamReader(const QByteArray &data)
QCborStreamReader(const char *data, qsizetype len)
QCborStreamReader(const quint8 *data, qsizetype len)
QCborStreamReader(const QCborStreamReader &)
~QCborStreamReader()
void addData(const QByteArray &data)
void addData(const char *data, qsizetype len)
void addData(const quint8 *data, qsizetype len)
void clear()
int containerDepth() const
qint64 currentOffset() const
qsizetype currentStringChunkSize() const
QIODevice *device() const
bool enterContainer()
bool hasNext() const
bool isArray() const
bool isBool() const
bool isByteArray() const
bool isContainer() const
bool isDouble() const
bool isFalse() const
bool isFloat16() const
bool isFloat() const
bool isInteger() const
bool isInvalid() const
bool isLengthKnown() const
bool isMap() const
bool isNegativeInteger() const
bool isNull() const
bool isSimpleType() const
bool isSimpleType(QCborSimpleType st) const
bool isString() const
bool isTag() const
bool isTrue() const
bool isUndefined() const
bool isUnsignedInteger() const
bool isValid() const
QCborError lastError() const
bool leaveContainer()
quint64 length() const
bool next(int maxRecursion = 10000)
QCborStreamReader::Type parentContainerType() const
(since 6.7) QByteArray readAllByteArray()
(since 6.7) QString readAllString()
(since 6.7) QByteArray readAllUtf8String()
(since 6.7) bool readAndAppendToByteArray(QByteArray &dst)
(since 6.7) bool readAndAppendToString(QString &dst)
(since 6.7) bool readAndAppendToUtf8String(QByteArray &dst)
QCborStreamReader::StringResult<QByteArray> readByteArray()
QCborStreamReader::StringResult<QString> readString()
QCborStreamReader::StringResult<qsizetype> readStringChunk(char *ptr, qsizetype maxlen)
(since 6.7) QCborStreamReader::StringResult<QByteArray> readUtf8String()
void reparse()
void reset()
void setDevice(QIODevice *device)
bool toBool() const
double toDouble() const
qfloat16 toFloat16() const
float toFloat() const
qint64 toInteger() const
QCborNegativeInteger toNegativeInteger() const
QCborSimpleType toSimpleType() const
QCborTag toTag() const
quint64 toUnsignedInteger() const
QCborStreamReader::Type type() const
QCborStreamReader &operator=(const QCborStreamReader &)

Descripción detallada

Esta clase se puede utilizar para decodificar un flujo de contenido CBOR directamente desde un objeto ` QByteArray ` o un ` QIODevice`. CBOR son las siglas de «Concise Binary Object Representation», una forma muy compacta de codificación de datos binarios compatible con JSON. Fue creado por el grupo de trabajo «Constrained RESTful Environments» (CoRE) de la IETF, que lo ha utilizado en muchos RFC nuevos. Está pensado para utilizarse junto con el protocolo CoAP.

QCborStreamReader proporciona una API similar a StAX, parecida a la de QXmlStreamReader. Su uso requiere ciertos conocimientos sobre la codificación CBOR. Para una API más sencilla, consulta QCborValue y, en especial, la función de decodificación QCborValue::fromCbor().

Normalmente, se crea un QCborStreamReader pasando la fuente QByteArray o QIODevice como parámetro al constructor y, a continuación, se extraen los elementos del flujo si no se han producido errores en la decodificación. Existen tres tipos de CBOR:

TipoTiposComportamiento
Ancho fijoEnteros, etiquetas, tipos simples, punto flotanteEl valor es analizado previamente por QCborStreamReader, por lo que las funciones de acceso son const. Es necesario llamar a next() para avanzar.
CadenasMatrices de bytes, cadenas de textoLa longitud (si se conoce) se analiza previamente, pero la cadena en sí no. Las funciones de acceso no son const y pueden asignar memoria. Una vez llamadas, las funciones de acceso avanzan automáticamente al siguiente elemento.
ContenedoresMatrices, mapasLa longitud (si se conoce) se analiza previamente. Para acceder a los elementos, debes llamar a ` enterContainer()`, leer todos los elementos y, a continuación, llamar a ` leaveContainer()`. Esa función avanza al siguiente elemento.

Por lo tanto, una función procesadora suele tener este aspecto:

void handleStream(QCborStreamReader &reader)
{
    switch (reader.type())
    {
    case QCborStreamReader::UnsignedInteger:
    case QCborStreamReader::NegativeInteger:
    case QCborStreamReader::SimpleType:
    case QCborStreamReader::Float16:
    case QCborStreamReader::Float:
    case QCborStreamReader::Double:
        handleFixedWidth(reader);
        reader.next();
        break;
    case QCborStreamReader::ByteArray:
    case QCborStreamReader::String:
        handleString(reader);
        break;
    case QCborStreamReader::Array:
    case QCborStreamReader::Map:
        reader.enterContainer();
        while (reader.lastError() == QCborError::NoError)
            handleStream(reader);
        if (reader.lastError() == QCborError::NoError)
            reader.leaveContainer();
    }

}

Compatibilidad con CBOR

La siguiente tabla enumera las características de CBOR que admite QCborStreamReader.

CaracterísticaCompatibilidad
Números sin signoSí (rango completo)
Números negativosSí (rango completo)
Cadenas de bytesSí
Cadenas de textoSí
Cadenas fragmentadasSí
EtiquetasSí (arbitrarias)
Valores booleanosSí
NuloSí
IndeterminadoSí
Valores simples arbitrariosSí
Número flotante de media precisión (16 bits)Sí
Número flotante de precisión simple (32 bits)Sí
Número real de doble precisión (64 bits)Sí
Valores infinitos y NaN en coma flotanteSí
Matrices y mapas de longitud determinadaSí
Matrices y mapas de longitud indeterminadaSí
Tipos de clave de mapa distintos de cadenas e enterosSí (arbitrarios)

Gestión de flujos CBOR no válidos o incompletos

QCborStreamReader es capaz de detectar por sí mismo entradas corruptas. La biblioteca que utiliza ha sido sometida a pruebas exhaustivas frente a entradas inválidas de cualquier tipo y es perfectamente capaz de notificar errores. Si se detecta alguno, QCborStreamReader establecerá ` lastError()` en un valor distinto de ` QCborError::NoError`, indicando qué situación se ha detectado.

La mayoría de los errores detectados por QCborStreamReader durante el análisis normal de los elementos no son recuperables. El código que utiliza QCborStreamReader puede optar por gestionar los datos que se han descodificado correctamente o bien descartar todos los datos.

El único error recuperable es ` QCborError::EndOfFile`, que indica que se necesitan más datos para completar el análisis. Esta situación resulta útil cuando se leen datos de una fuente asíncrona, como una tubería (`QProcess`) o un socket (`QTcpSocket`, ` QUdpSocket`, ` QNetworkReply`, etc.). Cuando llegan más datos, el código circundante debe llamar a ` addData()`, si se está analizando desde un ` QByteArray`, o a ` reparse()`, si, por el contrario, se está leyendo directamente desde un `QIDOevice` que ahora tiene más datos disponibles (véase ` setDevice()`).

Véase también QCborStreamWriter, QCborValue, QXmlStreamReader, «Análisis y visualización de datos CBOR», «Convertidor de serialización» y «Guardar y cargar una partida».

Documentación sobre los tipos de miembros

enum QCborStreamReader::StringResultCode

Esta enumeración la devuelven las funciones readString() y readByteArray(), y se utiliza para indicar el estado del análisis sintáctico.

ConstanteValorDescripción
QCborStreamReader::EndOfString0El análisis de la cadena se ha completado sin errores.
QCborStreamReader::Ok1La función ha devuelto datos; no se ha producido ningún error.
QCborStreamReader::Error-1El análisis ha fallado y se ha producido un error.

enum QCborStreamReader::Type

Esta enumeración contiene todos los tipos CBOR posibles, tal y como los descodifica QCborStreamReader. CBOR cuenta con 7 tipos principales, además de varios tipos simples que no contienen ningún valor y valores de coma flotante.

ConstanteValorDescripción
QCborStreamReader::UnsignedInteger0x00(Tipo principal 0) Va de 0 a264 - 1 (18 446 744 073 709 551 616)
QCborStreamReader::NegativeInteger0x20(Tipo principal 1) Va de -1 a-264 (-18 446 744 073 709 551 616)
QCborStreamReader::ByteArrayByteString(Tipo principal 2) Datos binarios arbitrarios.
QCborStreamReader::ByteString0x40Un alias de ByteArray.
QCborStreamReader::StringTextString(Tipo principal 3) Texto Unicode, que puede contener caracteres NUL.
QCborStreamReader::TextString0x60Un alias de String
QCborStreamReader::Array0x80(Tipo principal 4) Matriz de elementos heterogéneos.
QCborStreamReader::Map0xa0(Tipo principal 5) Mapa o diccionario de elementos heterogéneos.
QCborStreamReader::Tag0xc0(Tipo principal 6) Números que aportan un valor semántico adicional a los elementos CBOR genéricos. Consulta QCborTag para obtener más información.
QCborStreamReader::SimpleType0xe0(Tipo principal 7) Tipos que no aportan ningún valor adicional. Incluye valores booleanos (verdadero y falso), nulo e indefinido.
QCborStreamReader::Float16HalfFloatPunto flotante de media precisión IEEE 754 (qfloat16).
QCborStreamReader::HalfFloat0xf9Un alias de Float16.
QCborStreamReader::Float0xfaPunto flotante de precisión simple IEEE 754 (float).
QCborStreamReader::Double0xfbNúmero de coma flotante de doble precisión IEEE 754 (double).
QCborStreamReader::Invalid0xffNo es un tipo válido, ya sea por un error de análisis sintáctico o por haber llegado al final de una matriz o un mapa.

Documentación de funciones miembro

QCborStreamReader::QCborStreamReader()

Crea un objeto QCborStreamReader sin datos de origen. Tras su creación, QCborStreamReader indicará un error de análisis.

Puedes añadir más datos llamando a ` addData()` o configurando un dispositivo de origen diferente mediante ` setDevice()`.

Véanse también addData() y isValid().

[explicit] QCborStreamReader::QCborStreamReader(QIODevice *device)

Crea un objeto `QCborStreamReader` que analizará el flujo CBOR obtenido al leer desde ` device`. `QCborStreamReader` no asume la propiedad de ` device`, por lo que este debe permanecer válido hasta que se destruya este objeto.

Esta es una función sobrecargada.

[explicit] QCborStreamReader::QCborStreamReader(const QByteArray &data)

Crea un objeto QCborStreamReader que analizará el flujo CBOR que se encuentra en data.

Esta es una función sobrecargada.

QCborStreamReader::QCborStreamReader(const char *data, qsizetype len)

Crea un objeto `QCborStreamReader` con ` len ` bytes de datos a partir de ` data`. El puntero debe seguir siendo válido hasta que se destruya el objeto `QCborStreamReader`.

Esta es una función sobrecargada.

QCborStreamReader::QCborStreamReader(const quint8 *data, qsizetype len)

Crea un objeto QCborStreamReader con len bytes de datos a partir de la dirección data. El puntero debe seguir siendo válido hasta que se destruya el objeto QCborStreamReader.

Esta es una función sobrecargada.

[delete] QCborStreamReader::QCborStreamReader(const QCborStreamReader &)

Crea una instancia de ` QCborStreamReader` mediante copia. Esta función ha sido eliminada.

[noexcept] QCborStreamReader::~QCborStreamReader()

Destruye este objeto ` QCborStreamReader ` y libera los recursos asociados.

void QCborStreamReader::addData(const QByteArray &data)

Añade un ` data ` al flujo CBOR y vuelve a analizar el elemento actual. Esta función resulta útil si anteriormente se había llegado al final de los datos durante el procesamiento del flujo, pero ahora hay más datos disponibles.

void QCborStreamReader::addData(const char *data, qsizetype len)

Añade len bytes de datos, a partir de la dirección data, al flujo CBOR y vuelve a analizar el elemento actual. Esta función resulta útil si anteriormente se había llegado al final de los datos durante el procesamiento del flujo, pero ahora hay más datos disponibles.

Se trata de una función sobrecargada.

void QCborStreamReader::addData(const quint8 *data, qsizetype len)

Añade len bytes de datos, a partir de data, al flujo CBOR y vuelve a analizar el elemento actual. Esta función resulta útil si anteriormente se había llegado al final de los datos durante el procesamiento del flujo, pero ahora hay más datos disponibles.

Se trata de una función sobrecargada.

void QCborStreamReader::clear()

Borra el estado del decodificador y restablece los datos de la fuente de entrada a una matriz de bytes vacía. Tras llamar a esta función, ` QCborStreamReader ` indicará un error de análisis.

Llama a addData() para añadir más datos que se vayan a analizar.

Véanse también reset() y setDevice().

int QCborStreamReader::containerDepth() const

Devuelve el número de contenedores a los que este flujo ha entrado mediante ` enterContainer()` pero de los que aún no ha salido.

Véase también ` enterContainer()` y ` leaveContainer()`.

qint64 QCborStreamReader::currentOffset() const

Devuelve el desplazamiento en el flujo de entrada del elemento que se está decodificando en ese momento. El desplazamiento actual es el número de bytes decodificados hasta ese momento únicamente si los datos de origen son un « QByteArray » o si se trata de un « QIODevice » que se situó al principio del mismo cuando se inició la decodificación.

Véanse también reset(), clear() y device().

qsizetype QCborStreamReader::currentStringChunkSize() const

Devuelve el tamaño del fragmento actual de cadena de texto o de bytes. Si el flujo CBOR contiene una cadena no fragmentada (es decir, si ` isLengthKnown()` devuelve ` true`), esta función devuelve el tamaño de toda la cadena, al igual que ` length()`.

Esta función resulta útil para preasignar el búfer cuyo puntero se podrá pasar posteriormente a readStringChunk().

Véase también readString(), readByteArray() y readStringChunk().

QIODevice *QCborStreamReader::device() const

Devuelve el objeto ` QIODevice ` que se estableció mediante ` setDevice()` o el constructor ` QCborStreamReader `. Si este objeto estaba leyendo desde un ` QByteArray`, esta función devuelve `nullptr` en su lugar.

Véase también setDevice().

bool QCborStreamReader::enterContainer()

Accede al array o al mapa que constituye el elemento actual y se prepara para iterar por los elementos contenidos en el contenedor. Devuelve «true» si se ha accedido correctamente al contenedor; en caso contrario, devuelve «false» (normalmente, debido a un error de análisis sintáctico). Cada llamada a `enterContainer()` debe ir acompañada de una llamada a ` leaveContainer()`.

Esta función solo puede invocarse si el elemento actual es un array o un mapa (es decir, si isArray(), isMap() o isContainer() devuelven «true»). Invocarla en cualquier otra condición constituye un error.

Véanse también leaveContainer(), isContainer(), isArray() y isMap().

[noexcept] bool QCborStreamReader::hasNext() const

Devuelve «true» si quedan más elementos por descodificar en el contenedor actual o «false» si se ha llegado al final del mismo. Si se está analizando el elemento raíz, el hecho de que hasNext() devuelva «false» indica que el análisis ha finalizado; en caso contrario, si la profundidad del contenedor es distinta de cero, el código exterior debe llamar a leaveContainer().

Véanse también parentContainerType(), containerDepth() y leaveContainer().

bool QCborStreamReader::isArray() const

Devuelve «true» si el tipo del elemento actual es una matriz (es decir, si ` type()` devuelve ` QCborStreamReader::Array`). Si esta función devuelve «true», puedes llamar a ` enterContainer()` para comenzar a analizar ese contenedor.

Cuando el elemento actual es un array, también puedes llamar a ` isLengthKnown()` para averiguar si el tamaño del array está explícito en el flujo CBOR. Si es así, ese tamaño se puede obtener llamando a ` length()`.

El siguiente ejemplo preasigna un ` QVariantList ` en función del tamaño del array para lograr una decodificación más eficiente:

QVariantList populateFromCbor(QCborStreamReader &reader)
{
    QVariantList list;
    if (reader.isLengthKnown())
        list.reserve(reader.length());

    reader.enterContainer();
    while (reader.lastError() == QCborError::NoError && reader.hasNext())
        list.append(readOneElement(reader));
    if (reader.lastError() == QCborError::NoError)
        reader.leaveContainer();

    return list;
}

Nota: El código anterior no comprueba que la longitud sea un valor razonable. Si el flujo de entrada indica que la longitud es de 1.000 millones de elementos, la función anterior intentará asignar unos 16 GB o más de RAM, lo que puede provocar un fallo del sistema.

Véase también type(), isMap(), isLengthKnown(), length(), enterContainer() y leaveContainer().

bool QCborStreamReader::isBool() const

Devuelve «true» si el elemento actual es un valor booleano (true o false), y «false» si es cualquier otra cosa. Si esta función devuelve «true», puedes llamar a toBool() para recuperar el valor del booleano. También puedes llamar a toSimpleType() y compararlo con QCborSimpleValue::True o QCborSimpleValue::False.

Véase también type(), isFalse(), isTrue(), toBool(), isSimpleType() y toSimpleType().

bool QCborStreamReader::isByteArray() const

Devuelve «true» si el tipo del elemento actual es una matriz de bytes (es decir, si type() devuelve QCborStreamReader::ByteArray). Si esta función devuelve «true», puedes llamar a readByteArray() para leer esos datos.

Véanse también type(), readByteArray() y isString().

bool QCborStreamReader::isContainer() const

Devuelve «true» si el elemento actual es un contenedor (es decir, una matriz o un mapa), y «false» si es cualquier otra cosa. Si el elemento actual es un contenedor, se puede utilizar la función isLengthKnown() para averiguar si el tamaño del contenedor está explícito en el flujo y, en caso afirmativo, se puede utilizar length() para obtener dicho tamaño.

Y lo que es más importante, en el caso de un contenedor, la función enterContainer() permite comenzar a iterar por los elementos que contiene.

Véanse también type(), isArray(), isMap(), isLengthKnown(), length(), enterContainer(), leaveContainer() y containerDepth().

bool QCborStreamReader::isDouble() const

Devuelve «true» si el tipo del elemento actual es un número de coma flotante de doble precisión IEEE 754 (es decir, si ` type()` devuelve ` QCborStreamReader::Double`). Si esta función devuelve «true», puedes llamar a ` toDouble()` para leer esos datos.

Véanse también type(), toDouble(), isFloat16() y isFloat().

bool QCborStreamReader::isFalse() const

Devuelve «true» si el elemento actual es el valor « false », y «false» si es cualquier otra cosa.

Véase también type(), isTrue(), isBool(), toBool(), isSimpleType() y toSimpleType().

bool QCborStreamReader::isFloat16() const

Devuelve «true» si el tipo del elemento actual es un número de coma flotante de media precisión según el estándar IEEE 754 (es decir, si type() devuelve QCborStreamReader::Float16). Si esta función devuelve «true», puedes llamar a toFloat16() para leer esos datos.

Véanse también type(), toFloat16(), isFloat() y isDouble().

bool QCborStreamReader::isFloat() const

Devuelve «true» si el tipo del elemento actual es un número de coma flotante de precisión simple según el estándar IEEE 754 (es decir, si type() devuelve QCborStreamReader::Float). Si esta función devuelve «true», puedes llamar a toFloat() para leer esos datos.

Véanse también type(), toFloat(), isFloat16() y isDouble().

bool QCborStreamReader::isInteger() const

Devuelve «true» si el tipo del elemento actual es un entero sin signo o un entero negativo (es decir, si type() devuelve QCborStreamReader::UnsignedInteger o QCborStreamReader::NegativeInteger). Si esta función devuelve «true», puedes llamar a toInteger() para leer ese valor.

Véanse también type(), toInteger(), toUnsignedInteger(), toNegativeInteger(), isUnsignedInteger() y isNegativeInteger().

bool QCborStreamReader::isInvalid() const

Devuelve «true» si el elemento actual no es válido; en caso contrario, devuelve «false». El elemento actual puede no ser válido si se ha producido un error de decodificación o si acabamos de analizar el último elemento de un array o un mapa.

Nota: No hay que confundiresta función con isNull(). «Null» es un tipo CBOR normal que debe ser gestionado por la aplicación.

Véase también type() y isValid().

[noexcept] bool QCborStreamReader::isLengthKnown() const

Devuelve «true» si se conoce la longitud de la matriz, el mapa, la matriz de bytes o la cadena actual (de forma explícita en el flujo CBOR); en caso contrario, devuelve «false». Esta función solo debe invocarse si el elemento es uno de los mencionados.

Si se conoce la longitud, se puede obtener llamando a length().

Si se desconoce la longitud de un mapa o un array, esta viene determinada por el número de elementos presentes en el flujo. QCborStreamReader no dispone de ninguna API para calcular la longitud en esa situación.

Las cadenas y las matrices de bytes también pueden tener una longitud indeterminada (es decir, pueden transmitirse en varios fragmentos). Actualmente no es posible crearlas con ` QCborStreamWriter`, pero sí con otros codificadores, por lo que ` QCborStreamReader ` las admite.

Véanse también length(), QCborStreamWriter::startArray() y QCborStreamWriter::startMap().

bool QCborStreamReader::isMap() const

Devuelve «true» si el tipo del elemento actual es un mapa (es decir, si ` type()` devuelve ` QCborStreamReader::Map`). Si esta función devuelve «true», puedes llamar a ` enterContainer()` para comenzar a analizar ese contenedor.

Cuando el elemento actual es un mapa, también se puede llamar a ` isLengthKnown()` para averiguar si el tamaño del mapa está explícito en el flujo CBOR. Si es así, ese tamaño se puede obtener llamando a ` length()`.

El siguiente ejemplo preasigna un ` QVariantMap ` en función del tamaño del mapa para una decodificación más eficiente:

QVariantMap populateFromCbor(QCborStreamReader &reader)
{
    QVariantMap map;
    if (reader.isLengthKnown())
        map = setMapLength(map, reader.length());

    reader.enterContainer();
    while (reader.lastError() == QCborError::NoError && reader.hasNext()) {
        QString key = readElementAsString(reader);
        map.insert(key, readOneElement(reader));
    }
    if (reader.lastError() == QCborError::NoError)
        reader.leaveContainer();

    return map;
}

El ejemplo anterior utiliza una función llamada readElementAsString para leer las claves del mapa y obtener una cadena. Esto se debe a que los mapas CBOR pueden contener cualquier tipo como claves, no solo cadenas. El código del usuario debe realizar esta conversión, rechazar las claves que no sean cadenas o, en su lugar, utilizar un contenedor diferente al de QVariantMap y QVariantHash. Por ejemplo, si se espera que el mapa contenga claves enteras —lo cual se recomienda, ya que reduce el tamaño del flujo y el análisis—, el contenedor adecuado sería \l{QMap}<int, QVariant> o \l{QHash}<int, QVariant>.

Nota: El código anterior no comprueba que la longitud sea un valor razonable. Si el flujo de entrada indica que la longitud es de 1.000 millones de elementos, la función anterior intentará asignar unos 24 GB o más de RAM, lo que puede provocar un bloqueo del sistema.

Véase también type(), isArray(), isLengthKnown(), length(), enterContainer() y leaveContainer().

bool QCborStreamReader::isNegativeInteger() const

Devuelve «true» si el tipo del elemento actual es un entero negativo (es decir, si type() devuelve QCborStreamReader::NegativeInteger). Si esta función devuelve «true», puedes llamar a toNegativeInteger() o toInteger() para leer ese valor.

Véanse también type(), toNegativeInteger(), toInteger(), isInteger() y isUnsignedInteger().

bool QCborStreamReader::isNull() const

Devuelve «true» si el elemento actual es el valor « null », y «false» si es cualquier otra cosa. Los valores nulos pueden utilizarse para indicar la ausencia de algunos datos opcionales.

Nota: Esta función no es lo contrario de isValid(). Un valor nulo es un valor CBOR válido.

Véase también type(), isSimpleType() y toSimpleType().

bool QCborStreamReader::isSimpleType() const

Devuelve «true» si el tipo del elemento actual es cualquier tipo simple CBOR, incluidos los valores booleanos («true» y «false»), así como «null» e «undefined». Para averiguar de qué tipo simple se trata, llama a ` toSimpleType()`. Alternativamente, para comprobar si se trata de un tipo simple específico, llama a la sobrecarga que toma un parámetro ` QCborSimpleType `.

Los tipos simples de CBOR son tipos que no conllevan ningún valor adicional. Hay 255 posibilidades, pero actualmente solo hay cuatro valores que tienen un significado definido. No se espera que el código gestione tipos simples desconocidos y puede simplemente descartar el flujo como no válido si encuentra uno desconocido.

Véase también QCborSimpleType, type(), isSimpleType(QCborSimpleType) y toSimpleType().

bool QCborStreamReader::isSimpleType(QCborSimpleType st) const

Devuelve «true» si el tipo del elemento actual es el tipo simple « st »; en caso contrario, devuelve «false». Si esta función devuelve «true», entonces « toSimpleType()» devolverá « st ».

Los tipos simples CBOR son tipos que no contienen ningún valor adicional. Existen 255 posibilidades, pero actualmente solo hay cuatro valores que tienen un significado definido. No se espera que el código gestione los tipos simples desconocidos y puede simplemente descartar el flujo como no válido si encuentra uno desconocido.

Véase también « QCborSimpleType» , « type()», « isSimpleType()» y « toSimpleType()».

bool QCborStreamReader::isString() const

Devuelve «true» si el tipo del elemento actual es una cadena de texto (es decir, si type() devuelve QCborStreamReader::String). Si esta función devuelve «true», puedes llamar a readString() para leer esos datos.

Véanse también type(), readString() y isByteArray().

bool QCborStreamReader::isTag() const

Devuelve «true» si el tipo del elemento actual es una etiqueta CBOR (es decir, si type() devuelve QCborStreamReader::Tag). Si esta función devuelve «true», puedes llamar a toTag() para leer esos datos.

Véase también type() y toTag().

bool QCborStreamReader::isTrue() const

Devuelve «true» si el elemento actual es el valor « true », y «false» si es cualquier otra cosa.

Véase también type(), isFalse(), isBool(), toBool(), isSimpleType() y toSimpleType().

bool QCborStreamReader::isUndefined() const

Devuelve «true» si el elemento actual es el valor « undefined », y «false» si es cualquier otra cosa. Los valores indefinidos pueden codificarse para indicar que alguna conversión ha fallado o no ha sido posible al crear el flujo. « QCborStreamReader » nunca realiza ninguna sustitución y esta función solo devolverá «true» si el flujo contiene un valor indefinido explícito.

Véase también type(), isSimpleType() y toSimpleType().

bool QCborStreamReader::isUnsignedInteger() const

Devuelve «true» si el tipo del elemento actual es un entero sin signo (es decir, si type() devuelve QCborStreamReader::UnsignedInteger). Si esta función devuelve «true», puedes llamar a toUnsignedInteger() o a toInteger() para leer ese valor.

Véanse también type(), toUnsignedInteger(), toInteger(), isInteger() y isNegativeInteger().

bool QCborStreamReader::isValid() const

Devuelve «true» si el elemento actual es válido; en caso contrario, devuelve «false». El elemento actual puede no ser válido si se ha producido un error de decodificación o si acabamos de analizar el último elemento de un array o un mapa.

Nota: Esta función no es lo contrario de ` isNull()`. `null` es un tipo CBOR normal que debe ser gestionado por la aplicación.

Véanse también type() y isInvalid().

QCborError QCborStreamReader::lastError() const

Devuelve el último error producido al decodificar el flujo, si lo hubiera. Si no se ha producido ningún error, devuelve un objeto ` QCborError::NoError`.

Véase también isValid().

bool QCborStreamReader::leaveContainer()

Sale del array o mapa cuyos elementos se estaban procesando y sitúa el decodificador en el siguiente elemento tras el final del contenedor. Devuelve «true» si se ha salido correctamente del contenedor; «false» en caso contrario (normalmente, por un error de análisis). Cada llamada a ` enterContainer()` debe ir acompañada de una llamada a `leaveContainer()`.

Esta función solo puede invocarse si hasNext() ha devuelto «false» y containerDepth() no es cero. Invocarla en cualquier otra condición constituye un error.

Véanse también enterContainer(), parentContainerType() y containerDepth().

quint64 QCborStreamReader::length() const

Devuelve la longitud de la cadena o de la matriz de bytes, o bien el número de elementos de una matriz o el número de pares de elementos de un mapa, si se conoce. No se debe llamar a esta función si se desconoce la longitud (es decir, si isLengthKnown() devolvió false). Hacerlo supone un error y provocará que QCborStreamReader deje de analizar el flujo de entrada.

Véanse también isLengthKnown(), QCborStreamWriter::startArray() y QCborStreamWriter::startMap().

bool QCborStreamReader::next(int maxRecursion = 10000)

Avanza la decodificación del flujo CBOR un elemento. Normalmente, debes llamar a esta función al analizar elementos básicos de ancho fijo (es decir, enteros, valores simples, etiquetas y valores de coma flotante). Sin embargo, esta función también se puede llamar cuando el elemento actual es una cadena, una matriz o un mapa, y omitirá todo ese elemento, incluidos todos los elementos que contenga.

Esta función devuelve «true» si el avance se ha realizado correctamente; en caso contrario, devuelve «false». Puede fallar si el flujo está dañado o incompleto, o si el nivel de anidación de las matrices y los mapas supera el especificado en maxRecursion. Llamar a esta función cuando hasNext() ha devuelto «false» también constituye un error. Si esta función devuelve «false», lastError() devolverá el código de error que detalla cuál ha sido el fallo.

Véase también lastError(), isValid() y hasNext().

QCborStreamReader::Type QCborStreamReader::parentContainerType() const

Devuelve « QCborStreamReader::Array » o « QCborStreamReader::Map », lo que indica si el contenedor que contiene el elemento actual era un array o un mapa, respectivamente. Si en ese momento estamos analizando el elemento raíz, esta función devuelve « QCborStreamReader::Invalid ».

Véase también containerDepth() y enterContainer().

[since 6.7] QByteArray QCborStreamReader::readAllByteArray()

Decodifica la cadena de bytes actual y la devuelve. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error, esta función devuelve un QByteArray() construido por defecto, pero es posible que no se pueda distinguir de ciertas cadenas de bytes vacías. En su lugar, comprueba lastError() para determinar si se ha producido un error.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o cadenas. Por lo tanto, solo se puede invocar si isByteArray() es verdadero; invocarla en cualquier otra condición constituye un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véanse también readByteArray(), readStringChunk(), isByteArray() y readAllString().

[since 6.7] QString QCborStreamReader::readAllString()

Decodifica la cadena de texto actual y la devuelve. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error, esta función devuelve un QString() construido por defecto, pero es posible que no se pueda distinguir de ciertas cadenas de texto vacías. En su lugar, comprueba lastError() para determinar si se ha producido un error.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o de matrices de bytes. Por lo tanto, solo se puede invocar si isString() devuelve «true»; invocarla en cualquier otra circunstancia constituye un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véase también readString(), readStringChunk(), isString() y readAllByteArray().

[since 6.7] QByteArray QCborStreamReader::readAllUtf8String()

Decodifica la cadena de texto actual y la devuelve. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error, esta función devuelve un QString() construido por defecto, pero es posible que no se pueda distinguir de ciertas cadenas de texto vacías. En su lugar, comprueba lastError() para determinar si se ha producido un error.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o de matrices de bytes. Por lo tanto, solo se puede invocar si isString() ha devuelto «true»; invocarla en cualquier otra circunstancia constituye un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véase también readString(), readStringChunk(), isString() y readAllByteArray().

[since 6.7] bool QCborStreamReader::readAndAppendToByteArray(QByteArray &dst)

Decodifica la cadena de bytes actual y la añade a dst. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error durante la decodificación, es posible que, aun así, se hayan escrito en dst otros fragmentos que se hayan podido decodificar correctamente. Devuelve true si la decodificación se ha realizado sin errores; en caso contrario, devuelve false.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde enteros o cadenas. Por lo tanto, solo se puede invocar si isByteArray() es verdadero; invocarla en cualquier otra condición supone un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véase también readByteArray(), readStringChunk(), isByteArray() y readAndAppendToString().

[since 6.7] bool QCborStreamReader::readAndAppendToString(QString &dst)

Decodifica la cadena de texto actual y la añade a dst. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error durante la decodificación, es posible que, aun así, se hayan escrito en dst otros fragmentos que se hayan podido decodificar correctamente. Devuelve true si la decodificación se ha realizado sin errores; en caso contrario, devuelve false.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o de matrices de bytes. Por lo tanto, solo se puede invocar si isString() devolvió «true»; invocarla en cualquier otra condición constituye un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véase también readString(), readStringChunk(), isString() y readAndAppendToByteArray().

[since 6.7] bool QCborStreamReader::readAndAppendToUtf8String(QByteArray &dst)

Decodifica la cadena de texto actual y la añade a ` dst`. Si la cadena está dividida en fragmentos, esta función recorrerá todos los fragmentos y los concatenará. Si se produce un error durante la decodificación, es posible que, aun así, se hayan escrito en ` dst ` otros fragmentos que se hayan podido decodificar correctamente. Devuelve ` true ` si la decodificación se ha realizado sin errores; en caso contrario, devuelve ` false `.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o de matrices de bytes. Por lo tanto, solo se puede invocar si isString() ha devuelto «true»; invocarla en cualquier otra condición constituye un error.

Nota: Esta función no se puede reanudar. Es decir, no debe utilizarse en contextos en los que aún puedan recibirse datos CBOR, por ejemplo, desde un socket o una tubería. Solo debe utilizarse cuando ya se hayan recibido todos los datos y estén disponibles en la entrada QByteArray o QIODevice.

Esta función se introdujo en Qt 6.7.

Véase también readString(), readStringChunk(), isString() y readAndAppendToByteArray().

QCborStreamReader::StringResult<QByteArray> QCborStreamReader::readByteArray()

Decodifica un fragmento de matriz de bytes de la cadena CBOR y lo devuelve. Esta función se utiliza tanto para contenidos normales como fragmentados, por lo que el usuario debe llamar a esta función en bucle, incluso si isLengthKnown() es verdadero. El uso habitual de esta función es el siguiente:

QByteArray decodeBytearray(QCborStreamReader &reader)
{
    QByteArray result;
    auto r = reader.readByteArray();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readByteArray();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

La función readAllByteArray() implementa el bucle anterior y algunas comprobaciones adicionales.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o cadenas. Por lo tanto, solo se puede llamar si isByteArray() es verdadero; llamarla en cualquier otra condición constituye un error.

Véase también readAllByteArray(), readString(), isByteArray() y readStringChunk().

QCborStreamReader::StringResult<QString> QCborStreamReader::readString()

Decodifica un fragmento de cadena de la cadena CBOR y lo devuelve. Esta función se utiliza tanto para contenidos de cadena normales como fragmentados, por lo que el llamante debe llamar a esta función en bucle, incluso si isLengthKnown() es verdadero. El uso habitual de esta función es el siguiente:

QString decodeString(QCborStreamReader &reader)
{
    QString result;
    auto r = reader.readString();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readString();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

La función readAllString() implementa el bucle anterior y algunas comprobaciones adicionales.

Esta función no realiza ninguna conversión de tipos, ni siquiera a partir de enteros o matrices de bytes. Por lo tanto, solo se puede invocar si isString() ha devuelto «true»; invocarla en cualquier otra condición constituye un error.

Véanse también readAllString(), readByteArray(), isString() y readStringChunk().

QCborStreamReader::StringResult<qsizetype> QCborStreamReader::readStringChunk(char *ptr, qsizetype maxlen)

Lee el fragmento de cadena actual en el búfer al que apunta ` ptr`, cuyo tamaño es ` maxlen`. Esta función devuelve un objeto ` StringResult `, con el número de bytes copiados en ` ptr ` guardado en el miembro ` \l ` ` StringResult::data `. El miembro ` \l ` ` StringResult::status ` indica si se produjo un error al leer la cadena, si se copiaron datos o si se trataba del último fragmento.

Esta función se puede invocar tanto para los tipos « String » como para los de « ByteArray ». En el caso de estos últimos, esta función leerá los mismos datos que habría devuelto « readByteArray()». Para las cadenas, devuelve el equivalente en UTF-8 del « QString » que se habría devuelto.

Esta función suele utilizarse junto con ` currentStringChunkSize()` en un bucle. Por ejemplo:

QCborStreamReader::StringResult<qsizetype> result;
do {
    qsizetype size = reader.currentStringChunkSize();
    qsizetype oldsize = buffer.size();
    buffer.resize(oldsize + size);
    result = reader.readStringChunk(buffer.data() + oldsize, size);
} while (result.status == QCborStreamReader::Ok);

A diferencia de readByteArray() y readString(), esta función no está sujeta a las limitaciones de implementación de QByteArray y QString.

Nota: Esta función no comprueba que el contenido UTF-8 tenga el formato adecuado. Esto significa que esta función no genera el error « QCborError::InvalidUtf8String », incluso cuando readString() sí lo hace.

Véase también currentStringChunkSize(), readString(), readByteArray(), isString() y isByteArray().

[since 6.7] QCborStreamReader::StringResult<QByteArray> QCborStreamReader::readUtf8String()

Decodifica un fragmento de cadena de la cadena CBOR y lo devuelve. Esta función se utiliza tanto para contenidos de cadena normales como fragmentados, por lo que el llamante debe llamar a esta función en bucle, incluso si isLengthKnown() es verdadero. El uso habitual de esta función es similar al de readString() en el siguiente ejemplo:

QString decodeString(QCborStreamReader &reader)
{
    QString result;
    auto r = reader.readString();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readString();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

La función readAllUtf8String() implementa el bucle anterior y algunas comprobaciones adicionales.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde enteros o matrices de bytes. Por lo tanto, solo se puede llamar si isString() devuelve «true»; llamarla en cualquier otra condición constituye un error.

Esta función se introdujo en Qt 6.7.

Véase también readAllString(), readByteArray(), isString() y readStringChunk().

void QCborStreamReader::reparse()

Vuelve a analizar el elemento actual. Esta función debe llamarse cuando haya más datos disponibles en el ` QIODevice ` de origen después de que el análisis haya fallado por haberse llegado al final de los datos de entrada antes de llegar al final del flujo CBOR.

Al leer desde QByteArray(), la función addData() llama automáticamente a esta función. Llamarla cuando la lectura no ha fallado no tiene ningún efecto.

void QCborStreamReader::reset()

Restablece la fuente al principio y borra el estado del decodificador. Si los datos de origen eran un « QByteArray », « QCborStreamReader » se reiniciará desde el principio de la matriz.

Si los datos de origen son un ` QIODevice`, esta función llamará a ` QIODevice::reset()`, que buscará la posición de byte 0. Si no se encuentra el flujo CBOR al principio del dispositivo (por ejemplo, al principio de un archivo), es probable que esta función no funcione correctamente. En su lugar, coloque el ` QIODevice ` en el desplazamiento correcto y llame a ` setDevice()`.

Véase también clear() y setDevice().

void QCborStreamReader::setDevice(QIODevice *device)

Establece la fuente de datos en « device » y restablece el decodificador a su estado inicial.

Véase también device().

bool QCborStreamReader::toBool() const

Devuelve el valor booleano del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde enteros. Por lo tanto, solo se puede invocar si isTrue(), isFalse() o isBool() han devuelto «true»; invocarla en cualquier otra condición supone un error.

Véanse también isBool(), isTrue(), isFalse() y toInteger().

double QCborStreamReader::toDouble() const

Devuelve el valor de coma flotante de doble precisión de 64 bits del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde otros tipos de punto flotante o desde valores enteros. Por lo tanto, solo se puede invocar si isDouble() es verdadero; invocarla en cualquier otra condición genera un error.

Véanse también isDouble(), toFloat16() y toFloat().

qfloat16 QCborStreamReader::toFloat16() const

Devuelve el valor de punto flotante de media precisión (16 bits) del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde otros tipos de punto flotante o desde valores enteros. Por lo tanto, solo se puede invocar si isFloat16() es verdadero; invocarla en cualquier otra condición constituye un error.

Véase también isFloat16(), toFloat() y toDouble().

float QCborStreamReader::toFloat() const

Devuelve el valor de punto flotante de precisión simple de 32 bits del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde otros tipos de punto flotante o desde valores enteros. Por lo tanto, solo se puede invocar si isFloat() es verdadero; invocarla en cualquier otra condición constituye un error.

Véanse también isFloat(), toFloat16() y toDouble().

qint64 QCborStreamReader::toInteger() const

Devuelve el valor entero del elemento actual, ya sea negativo, positivo o cero. Si el valor es mayor que263 - 1 o menor que-263, el valor devuelto sufrirá un desbordamiento y tendrá un signo incorrecto. Si es necesario gestionar esos valores, utiliza en su lugar toUnsignedInteger() o toNegativeInteger().

Esta función no realiza ninguna conversión de tipo, ni siquiera desde valores booleanos o etiquetas CBOR. Por lo tanto, solo se puede invocar si isInteger() es verdadero; invocarla en cualquier otra condición supone un error.

Véase también isInteger(), toUnsignedInteger() y toNegativeInteger().

QCborNegativeInteger QCborStreamReader::toNegativeInteger() const

Devuelve el valor entero negativo del elemento actual. QCborNegativeValue es un entero sin signo de 64 bits que contiene el valor absoluto del número negativo almacenado en el flujo CBOR. Además, QCborNegativeValue(0) representa el número-264.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde valores booleanos o etiquetas CBOR. Por lo tanto, solo se puede invocar si isNegativeInteger() es verdadero; invocarla en cualquier otra condición constituye un error.

Esta función puede utilizarse para obtener números que superen el rango del tipo de retorno de ` toInteger()`. Sin embargo, se desaconseja encarecidamente el uso de números negativos menores que-263.

Véanse también type(), toInteger(), isNegativeInteger() y isUnsignedInteger().

QCborSimpleType QCborStreamReader::toSimpleType() const

Devuelve el valor del tipo simple actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde enteros. Por lo tanto, solo se puede invocar si isSimpleType() es verdadero; invocarla en cualquier otra condición genera un error.

Véanse también isSimpleType(), isTrue(), isFalse(), isBool(), isNull() y isUndefined().

QCborTag QCborStreamReader::toTag() const

Devuelve el valor de la etiqueta del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde enteros. Por lo tanto, solo se puede invocar si isTag() es verdadero; invocarla en cualquier otra condición supone un error.

Las etiquetas son números de 64 bits asociados a tipos CBOR genéricos que les aportan un significado adicional. Para obtener una lista de las etiquetas conocidas, consulta la enumeración QCborKnownTags.

Véase también isTag(), toInteger() y QCborKnownTags.

quint64 QCborStreamReader::toUnsignedInteger() const

Devuelve el valor entero sin signo del elemento actual.

Esta función no realiza ninguna conversión de tipos, ni siquiera desde booleano o la etiqueta CBOR. Por lo tanto, solo se puede invocar si isUnsignedInteger() es verdadero; invocarla en cualquier otra condición constituye un error.

Esta función puede utilizarse para obtener números que superen el rango del tipo de retorno de toInteger().

Véase también type(), toInteger(), isUnsignedInteger() y isNegativeInteger().

QCborStreamReader::Type QCborStreamReader::type() const

Devuelve el tipo del elemento actual. Puede ser uno de los tipos válidos o «Invalid».

Véase también isValid(), isUnsignedInteger(), isNegativeInteger(), isInteger(), isByteArray(), isString(), isArray(), isMap(), isTag(), isSimpleType(), isBool(), isFalse(), isTrue(), isNull(), isUndefined(), isFloat16(), isFloat() y isDouble().

[delete] QCborStreamReader &QCborStreamReader::operator=(const QCborStreamReader &)

Asigna por copia other a esta instancia de QCborStreamReader. Esta función se ha eliminado.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.