QAbstractProtobufSerializer Class
La clase QAbstractProtobufSerializer es una interfaz que representa las funciones básicas de serialización y deserialización. Más información...
| Cabecera: | #include <QAbstractProtobufSerializer> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Protobuf) target_link_libraries(mytarget PRIVATE Qt6::Protobuf) |
| Desde: | Qt 6.5 |
| Heredado por: |
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
(since 6.8) enum class | Error { None, InvalidHeader, UnknownType, UnexpectedEndOfStream, InvalidFormat } |
Funciones públicas
| QAbstractProtobufSerializer() | |
| virtual | ~QAbstractProtobufSerializer() |
| bool | deserialize(QProtobufMessage *message, QByteArrayView data) const |
(since 6.8) virtual QAbstractProtobufSerializer::Error | lastError() const = 0 |
(since 6.8) virtual QString | lastErrorString() const = 0 |
| QByteArray | serialize(const QProtobufMessage *message) const |
Funciones privadas
| virtual bool | deserializeMessage(QProtobufMessage *message, QByteArrayView data) const = 0 |
| virtual QByteArray | serializeMessage(const QProtobufMessage *message) const = 0 |
Macros
Descripción detallada
La clase ` QProtobufSerializer ` registra serializadores y deserializadores para clases que implementan un mensaje Protobuf, heredando de ` QProtobufMessage`. Estas clases se generan automáticamente a partir de un archivo ` .proto `, utilizando la función de CMake `qt_add_protobuf ` o ejecutando directamente `qtprotobufgen `.
Esta clase debe utilizarse como base para serializadores específicos. La propiedad `handlers` contiene todos los serializadores específicos de los mensajes y debe utilizarse durante la serialización y deserialización. Las clases heredadas deben reimplementar el ámbito de los métodos virtuales que utilizan las funciones registradas de serialización y deserialización de mensajes.
Documentación de los tipos de miembros
[since 6.8] enum class QAbstractProtobufSerializer::Error
Esta enumeración contiene los posibles errores que pueden producirse durante la deserialización. Cuando se produzca un error, llama a lastErrorString() para obtener un mensaje de error comprensible para el usuario.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractProtobufSerializer::Error::None | 0 | No se ha producido ningún error. |
QAbstractProtobufSerializer::Error::InvalidHeader | 1 | Se ha producido un error al intentar descodificar un encabezado del mensaje. |
QAbstractProtobufSerializer::Error::UnknownType | 2 | Al serializar o deserializar un mensaje, no se ha encontrado ningún deserializador para un campo del mensaje. |
QAbstractProtobufSerializer::Error::UnexpectedEndOfStream | 3 | Al deserializar un mensaje, el flujo terminó de forma inesperada. |
QAbstractProtobufSerializer::Error::InvalidFormat | 4 | Los datos tienen un formato no válido. Por ejemplo, el valor JSON no coincide con el tipo de campo. |
Esta enumeración se introdujo en Qt 6.8.
Documentación de funciones de miembro
[constexpr noexcept default] QAbstractProtobufSerializer::QAbstractProtobufSerializer()
Crea por defecto una instancia de ` QAbstractProtobufSerializer`.
[virtual noexcept] QAbstractProtobufSerializer::~QAbstractProtobufSerializer()
Elimina esto: QAbstractProtobufSerializer.
bool QAbstractProtobufSerializer::deserialize(QProtobufMessage *message, QByteArrayView data) const
Deserializa un mensaje Protobuf registrado message a partir de un QByteArray data . message no debe ser nullptr. Devuelve true si la deserialización se ha realizado correctamente; en caso contrario, devuelve false.
Las propiedades inesperadas o desconocidas en el objeto ` data ` se omiten.
Véase también serialize().
[pure virtual private] bool QAbstractProtobufSerializer::deserializeMessage(QProtobufMessage *message, QByteArrayView data) const
Esta función es llamada por ` deserialize()` para deserializar un objeto Protobuf registrado ` message ` a partir de un objeto ` QByteArrayView ` ` data`. Se puede dar por hecho que ` message ` no es ` nullptr`. Devuelve ` true ` si la deserialización se ha realizado correctamente; en caso contrario, devuelve ` false`.
[pure virtual, since 6.8] QAbstractProtobufSerializer::Error QAbstractProtobufSerializer::lastError() const
Devuelve el último error de la instancia del serializador.
Esta función se introdujo en Qt 6.8.
Véase también lastErrorString().
[pure virtual, since 6.8] QString QAbstractProtobufSerializer::lastErrorString() const
Devuelve la última cadena de error de la instancia del serializador.
Esta función se introdujo en Qt 6.8.
Véase también lastError().
QByteArray QAbstractProtobufSerializer::serialize(const QProtobufMessage *message) const
Serializa un mensaje Protobuf registrado message en un QByteArray. message no debe ser nullptr.
Véase también deserialize().
[pure virtual private] QByteArray QAbstractProtobufSerializer::serializeMessage(const QProtobufMessage *message) const
Esta función es llamada por ` serialize()` para serializar un Protobuf registrado ` message`. ` message ` no debe ser ` nullptr`. Devuelve un ` QByteArray ` que contiene el mensaje serializado.
Documentación de macros
Q_PROTOBUF_OBJECT
Declara el miembro `propertyOrdering` en una clase que hereda de ` QProtobufMessage`. Se utiliza como parte del código generado por la herramienta `qtprotobufgen`.
© 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.