QDataStream Class

Documentación de las funciones miembro

QDataStream::QDataStream()

Construye un flujo de datos que no tiene dispositivo de E/S.

Véase también setDevice().

[explicit] QDataStream::QDataStream(QIODevice *d)

Construye un flujo de datos que utiliza el dispositivo de E/S d.

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

QDataStream::QDataStream(const QByteArray &a)

Construye un flujo de datos de sólo lectura que opera sobre la matriz de bytes a. Usa QDataStream(QByteArray*, int) si quieres escribir en un array de bytes.

Dado que QByteArray no es una subclase de QIODevice, internamente se crea una QBuffer para envolver el array de bytes.

QDataStream::QDataStream(QByteArray *a, QIODeviceBase::OpenMode mode)

Construye un flujo de datos que opera sobre una matriz de bytes, a. En mode se describe cómo se va a utilizar el dispositivo.

Alternativamente, puedes usar QDataStream(const QByteArray &) si solo quieres leer de un array de bytes.

Dado que QByteArray no es una subclase de QIODevice, internamente se crea una QBuffer para envolver el array de bytes.

[noexcept] QDataStream::~QDataStream()

Destruye el flujo de datos.

El destructor no afectará al dispositivo de E/S actual, a menos que sea un dispositivo de E/S interno (por ejemplo, un QBuffer) procesando un QByteArray pasado en el constructor, en cuyo caso el dispositivo de E/S interno es destruido.

void QDataStream::abortTransaction()

Aborta una transacción de lectura.

Esta función se utiliza comúnmente para descartar la transacción después de errores de protocolo de nivel superior o pérdida de sincronización del flujo.

Si se llama en una transacción interna, el aborto se delega a la transacción más externa, y las transacciones internas iniciadas posteriormente son forzadas a fallar.

Para la transacción más externa, descarta el punto de restauración y cualquier dato duplicado internamente del flujo. No afectará a la posición de lectura actual del flujo.

Establece el estado del flujo de datos a

Véase también startTransaction(), commitTransaction(), y rollbackTransaction().

bool QDataStream::atEnd() const

Devuelve true si el dispositivo de E/S ha alcanzado la posición final (final del flujo o archivo) o si no hay ningún dispositivo de E/S establecido; en caso contrario devuelve false.

Véase también QIODevice::atEnd().

QDataStream::ByteOrder QDataStream::byteOrder() const

Devuelve el orden actual de los bytes: BigEndian o LittleEndian.

Véase también setByteOrder().

bool QDataStream::commitTransaction()

Completa una transacción de lectura. Devuelve true si no se han producido errores de lectura durante la transacción; en caso contrario devuelve false.

Si se llama a una transacción interna, la confirmación se pospondrá hasta que se produzca la llamada externa a commitTransaction(), rollbackTransaction(), o abortTransaction().

De lo contrario, si el estado del flujo indica que se ha leído más allá del final de los datos, esta función restaura los datos del flujo al punto de la llamada a startTransaction(). Cuando se produce esta situación, es necesario esperar a que lleguen más datos, tras lo cual se inicia una nueva transacción. Si el flujo de datos ha leído datos corruptos o se ha abortado alguna de las transacciones internas, esta función aborta la transacción.

Véase también startTransaction(), rollbackTransaction(), y abortTransaction().

QIODevice *QDataStream::device() const

Devuelve el dispositivo de E/S configurado actualmente, o nullptr si no hay ningún dispositivo configurado.

Véase también setDevice().

QDataStream::FloatingPointPrecision QDataStream::floatingPointPrecision() const

Devuelve la precisión en coma flotante del flujo de datos.

Véase también FloatingPointPrecision y setFloatingPointPrecision().

[since 6.7] QDataStream &QDataStream::readBytes(char *&s, qint64 &l)

Lee el búfer s del flujo y devuelve una referencia al flujo.

El búfer s se asigna utilizando new []. Se destruye con el operador delete [].

El parámetro l se establece en la longitud del búfer. Si la cadena leída está vacía, l se pone a 0 y s se pone a nullptr.

El formato de serialización es primero un especificador de longitud y luego l bytes de datos. El especificador de longitud es un quint32 si la versión es inferior a 6.7 o si el número de elementos es inferior a 0xfffffffe (2^32 -2), de lo contrario hay un valor de extensión 0xfffffffe seguido de un quint64 con el valor real. Además, para los contenedores que soportan isNull(), se codifica como un único quint32 con todos los bits establecidos y sin datos.

Esta función se introdujo en Qt 6.7.

Véase también readRawData() y writeBytes().

qint64 QDataStream::readRawData(char *s, qint64 len)

Lee como máximo len bytes del flujo en s y devuelve el número de bytes leídos. Si se produce un error, esta función devuelve -1.

El búfer s debe estar preasignado. Los datos no se descodifican.

Véase también readBytes(), QIODevice::read(), y writeRawData().

void QDataStream::resetStatus()

Restablece el estado del flujo de datos.

Véase también Status, status(), y setStatus().

void QDataStream::rollbackTransaction()

Revierte una transacción de lectura.

Esta función se utiliza normalmente para revertir la transacción cuando se detecta una lectura incompleta antes de confirmar la transacción.

Si se llama en una transacción interna, la reversión se delega a la transacción más externa, y las transacciones internas iniciadas posteriormente son forzadas a fallar.

Para la transacción más externa, restaura los datos del flujo al punto de la llamada a startTransaction(). Si el flujo de datos ha leído datos corruptos o alguna de las transacciones internas ha sido abortada, esta función aborta la transacción.

Si las operaciones de flujo anteriores tuvieron éxito, establece el estado del flujo de datos a

Véase también startTransaction(), commitTransaction(), y abortTransaction().

void QDataStream::setByteOrder(QDataStream::ByteOrder bo)

Establece el orden de los bytes de serialización en bo.

El parámetro bo puede ser QDataStream::BigEndian o QDataStream::LittleEndian.

La configuración por defecto es big-endian. Recomendamos dejar esta configuración a menos que tenga requisitos especiales.

Véase también byteOrder().

void QDataStream::setDevice(QIODevice *d)

void QDataStream::setDevice(QIODevice *d)

Establece el dispositivo de E/S a d, que puede ser nullptr para desestablecer el dispositivo de E/S actual.

Ver también device().

void QDataStream::setFloatingPointPrecision(QDataStream::FloatingPointPrecision precision)

Establece la precisión en coma flotante del flujo de datos en precision. Si la precisión en coma flotante es DoublePrecision y la versión del flujo de datos es Qt_4_6 o superior, todos los números en coma flotante se escribirán y leerán con precisión de 64 bits. Si la precisión en coma flotante es SinglePrecision y la versión es Qt_4_6 o superior, todos los números en coma flotante se escribirán y leerán con precisión de 32 bits.

Para versiones anteriores a Qt_4_6, la precisión de los números en coma flotante en el flujo de datos depende del operador de flujo llamado.

El valor por defecto es DoublePrecision.

Tenga en cuenta que esta propiedad no afecta a la serialización o deserialización de las instancias de qfloat16.

Véase también floatingPointPrecision().

void QDataStream::setStatus(QDataStream::Status status)

Establece el estado del flujo de datos en status.

Las llamadas posteriores a setStatus() se ignoran hasta que se llame a resetStatus().

Véase también Status, status(), y resetStatus().

void QDataStream::setVersion(int v)

Establece el número de versión del formato de serialización de datos a v, un valor del enum Version.

No tienes que establecer una versión si estás usando la versión actual de Qt, pero para tus propios formatos binarios personalizados te recomendamos que lo hagas; mira Versioning en la Descripción Detallada.

Para acomodar la nueva funcionalidad, el formato de serialización del flujo de datos de algunas clases Qt ha cambiado en algunas versiones de Qt. Si quieres leer datos que fueron creados por una versión anterior de Qt, o escribir datos que puedan ser leídos por un programa que fue compilado con una versión anterior de Qt, usa esta función para modificar el formato de serialización usado por QDataStream.

El enum Version proporciona constantes simbólicas para las diferentes versiones de Qt. Por ejemplo:

QDataStream out(&file);
out.setVersion(QDataStream::Qt_4_0);

Ver también version() y Version.

qint64 QDataStream::skipRawData(qint64 len)

Omite len bytes del dispositivo. Devuelve el número de bytes realmente omitidos, o -1 en caso de error.

Esto equivale a llamar a readRawData() en un búfer de longitud len e ignorar el búfer.

Véase también QIODevice::seek().

void QDataStream::startTransaction()

Inicia una nueva transacción de lectura en el flujo.

Define un punto restaurable dentro de la secuencia de operaciones de lectura. Para dispositivos secuenciales, los datos leídos se duplicarán internamente para permitir la recuperación en caso de lecturas incompletas. Para dispositivos de acceso aleatorio, esta función guarda la posición actual del flujo. Llame a commitTransaction(), rollbackTransaction(), o abortTransaction() para finalizar la transacción actual.

Una vez iniciada una transacción, las llamadas posteriores a esta función harán que la transacción sea recursiva. Las transacciones internas actúan como agentes de la transacción externa (es decir, informan del estado de las operaciones de lectura a la transacción externa, que puede restaurar la posición del flujo).

Cuando se produce un error durante una transacción (incluyendo el fallo de una transacción interna), la lectura del flujo de datos se suspende (todas las operaciones de lectura posteriores devuelven valores vacíos/cero) y las transacciones internas posteriores se ven forzadas a fallar. El inicio de una nueva transacción externa recupera este estado. Este comportamiento hace innecesario comprobar los errores de cada operación de lectura por separado.

Véase también commitTransaction(), rollbackTransaction(), y abortTransaction().

QDataStream::Status QDataStream::status() const

Devuelve el estado del flujo de datos.

Véase también Status, setStatus(), y resetStatus().

int QDataStream::version() const

Devuelve el número de versión del formato de serialización de datos.

Véase también setVersion() y Version.

QDataStream &QDataStream::writeBytes(const char *s, qint64 len)

Escribe el especificador de longitud len y el búfer s en el flujo y devuelve una referencia al flujo.

len se serializa como un quint32 y un quint64 opcional, seguido de len bytes de s. Tenga en cuenta que los datos no están codificados.

Véase también writeRawData() y readBytes().

qint64 QDataStream::writeRawData(const char *s, qint64 len)

Escribe len bytes desde s al flujo. Devuelve el número de bytes realmente escritos, o -1 en caso de error. Los datos no se codifican.

Véase también writeBytes(), QIODevice::write() y readRawData().

[explicit noexcept, since 6.10] QDataStream::operator bool() const

Devuelve si este flujo no tiene errores (status() devuelve Ok).

Esta función se introdujo en Qt 6.10.

QDataStream &QDataStream::operator<<(qint8 i)

Escribe un byte con signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(bool i)

Escribe un valor booleano, i, en el flujo. Devuelve una referencia al flujo.

[since 6.0] QDataStream &QDataStream::operator<<(char16_t c)

Escribe un carácter, c, en el flujo. Devuelve una referencia al flujo

Esta función se introdujo en Qt 6.0.

[since 6.0] QDataStream &QDataStream::operator<<(char32_t c)

Escribe un carácter, c, en el flujo. Devuelve una referencia al flujo

Esta función se introdujo en Qt 6.0.

QDataStream &QDataStream::operator<<(const char *s)

Escribe la cadena '\0'-terminada s en el flujo y devuelve una referencia al flujo.

La cadena se serializa utilizando writeBytes().

Véase también writeBytes() y writeRawData().

QDataStream &QDataStream::operator<<(double f)

Escribe un número en coma flotante, f, en el flujo utilizando el formato estándar IEEE 754. Devuelve una referencia al flujo.

Véase también setFloatingPointPrecision().

QDataStream &QDataStream::operator<<(float f)

Escribe un número en coma flotante, f, en el flujo utilizando el formato estándar IEEE 754. Devuelve una referencia al flujo.

Véase también setFloatingPointPrecision().

QDataStream &QDataStream::operator<<(qint16 i)

Escribe un entero de 16 bits con signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(qint32 i)

Escribe un entero de 32 bits con signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(qint64 i)

Escribe un entero de 64 bits con signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(quint16 i)

Escribe un entero de 16 bits sin signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(quint32 i)

Escribe un entero sin signo, i, en el flujo como un entero sin signo de 32 bits (quint32). Devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(quint64 i)

Escribe un entero de 64 bits sin signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(quint8 i)

Escribe un byte sin signo, i, en el flujo y devuelve una referencia al flujo.

QDataStream &QDataStream::operator<<(std::nullptr_t ptr)

Simula la escritura de un std::nullptr_t, ptr, en el flujo y devuelve una referencia al flujo. En realidad, esta función no escribe nada en el flujo, ya que los valores de std::nullptr_t se almacenan como 0 bytes.

QDataStream &QDataStream::operator>>(bool &i)

Lee un valor booleano del flujo en i. Devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(qint8 &i)

Lee un byte con signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(char *&s)

Lee la cadena s del flujo y devuelve una referencia al flujo.

La cadena se deserializa utilizando readBytes(), donde el formato de serialización es un especificador de longitud quint32 en primer lugar, seguido de la misma cantidad de bytes de datos. La cadena resultante es siempre '\0'-terminada.

El espacio para la cadena se asigna utilizando new [] - la persona que llama debe destruirlo con delete [].

Véase también readBytes() y readRawData().

[since 6.0] QDataStream &QDataStream::operator>>(char16_t &c)

Lee un carácter de 16 bits de ancho del flujo en c y devuelve una referencia al flujo.

Esta función se introdujo en Qt 6.0.

[since 6.0] QDataStream &QDataStream::operator>>(char32_t &c)

Lee un carácter de 32 bits de ancho del flujo en c y devuelve una referencia al flujo.

Esta función se introdujo en Qt 6.0.

QDataStream &QDataStream::operator>>(double &f)

Lee un número en coma flotante del flujo en f, utilizando el formato estándar IEEE 754. Devuelve una referencia al flujo.

Véase también setFloatingPointPrecision().

QDataStream &QDataStream::operator>>(float &f)

Lee un número en coma flotante del flujo en f, utilizando el formato estándar IEEE 754. Devuelve una referencia al flujo.

Véase también setFloatingPointPrecision().

QDataStream &QDataStream::operator>>(qint16 &i)

Lee un entero de 16 bits con signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(qint32 &i)

Lee un entero de 32 bits con signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(qint64 &i)

Lee un entero de 64 bits con signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(quint16 &i)

Lee un entero de 16 bits sin signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(quint32 &i)

Lee un entero de 32 bits sin signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(quint64 &i)

Lee un entero de 64 bits sin signo del flujo, en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(quint8 &i)

Lee un byte sin signo del flujo en i, y devuelve una referencia al flujo.

QDataStream &QDataStream::operator>>(std::nullptr_t &ptr)

Simula la lectura de un std::nullptr_t del flujo en ptr y devuelve una referencia al flujo. Esta función no lee realmente nada del flujo, ya que los valores de std::nullptr_t se almacenan como 0 bytes.