Skip to content

PythonQt.Qt.QDataStream

QDataStream

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A data stream is a binary stream of encoded information which is 100% independent of the host computer's operating system, CPU or byte order. For example, a data stream that is written by a PC under Windows can be read by a Sun SPARC running Solaris.

You can also use a data stream to read/write raw unencoded binary data. If you want a "parsing" input stream, see QTextStream.

The QDataStream class implements the serialization of C++'s basic data types, like char, short, int, char *, etc. Serialization of more complex data is accomplished by breaking up the data into primitive units.

A data stream cooperates closely with a QIODevice. A QIODevice represents an input/output medium one can read data from and write data to. The QFile class is an example of an I/O device.

Example (write binary data to a stream):

QFile file("file.dat");
file.open(QIODevice::WriteOnly);
QDataStream out(&file);   // we will serialize the data into the file
out << QString("the answer is");   // serialize a string
out << (qint32)42;        // serialize an integer

Example (read binary data from a stream):

QFile file("file.dat");
file.open(QIODevice::ReadOnly);
QDataStream in(&file);    // read the data serialized from the file
QString str;
qint32 a;
in >> str >> a;           // extract "the answer is" and 42

Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported Qt types include QBrush, QColor, QDateTime, QFont, QPixmap, QString, QVariant and many others. For the complete list of all Qt types supporting data streaming see Serializing Qt Data Types.

For integers it is best to always cast to a Qt integer type for writing, and to read back into the same Qt integer type. This ensures that you get integers of the size you want and insulates you from compiler and platform differences.

Enumerations can be serialized through QDataStream without the need of manually defining streaming operators. Enum classes are serialized using the declared size.

To take one example, a char * string is written as a 32-bit integer equal to the length of the string including the '\0' byte, followed by all the characters of the string including the '\0' byte. When reading a char * string, 4 bytes are read to create the 32-bit length value, then that many characters for the char * string including the '\0' terminator are read.

The initial I/O device is usually set in the constructor, but can be changed with setDevice(). If you've reached the end of the data (or if there is no I/O device set) atEnd() will return true.

Versioning

QDataStream's binary format has evolved since Qt 1.0, and is likely to continue evolving to reflect changes done in Qt. When inputting or outputting complex types, it's very important to make sure that the same version of the stream (version()) is used for reading and writing. If you need both forward and backward compatibility, you can hardcode the version number in the application:

stream.setVersion(QDataStream::Qt_4_0);

If you are producing a new binary data format, such as a file format for documents created by your application, you could use a QDataStream to write the data in a portable format. Typically, you would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example:

QFile file("file.xxx");
file.open(QIODevice::WriteOnly);
QDataStream out(&file);

// Write a header with a "magic number" and a version
out << (quint32)0xA0B0C0D0;
out << (qint32)123;

out.setVersion(QDataStream::Qt_4_0);

// Write the data
out << lots_of_interesting_data;

Then read it in with:

QFile file("file.xxx");
file.open(QIODevice::ReadOnly);
QDataStream in(&file);

// Read and check the header
quint32 magic;
in >> magic;
if (magic != 0xA0B0C0D0)
    return XXX_BAD_FILE_FORMAT;

// Read the version
qint32 version;
in >> version;
if (version < 100)
    return XXX_BAD_FILE_TOO_OLD;
if (version > 123)
    return XXX_BAD_FILE_TOO_NEW;

if (version <= 110)
    in.setVersion(QDataStream::Qt_3_2);
else
    in.setVersion(QDataStream::Qt_4_0);

// Read the data
in >> lots_of_interesting_data;
if (version >= 120)
    in >> data_new_in_XXX_version_1_2;
in >> other_interesting_data;

You can select which byte order to use when serializing data. The default setting is big-endian (MSB first). Changing it to little-endian breaks the portability (unless the reader also changes to little-endian). We recommend keeping this setting unless you have special requirements.

Reading and Writing Raw Binary Data

You may wish to read/write your own raw binary data to/from the data stream directly. Data may be read from the stream into a preallocated char * using readRawData(). Similarly data can be written to the stream using writeRawData(). Note that any encoding/decoding of the data must be done by you.

A similar pair of functions is readBytes() and writeBytes(). These differ from their raw counterparts as follows: readBytes() reads a quint32 which is taken to be the length of the data to be read, then that number of bytes is read into the preallocated char *; writeBytes() writes a quint32 containing the length of the data, followed by the data. Note that any encoding/decoding of the data (apart from the length quint32) must be done by you.

Reading and Writing Qt Collection Classes

The Qt container classes can also be serialized to a QDataStream. These include QList, QLinkedList, QVector, QSet, QHash, and QMap. The stream operators are declared as non-members of the classes.

Reading and Writing Other Qt Classes

In addition to the overloaded stream operators documented here, any Qt classes that you might want to serialize to a QDataStream will have appropriate stream operators declared as non-member of the class:

    QDataStream &operator<<(QDataStream &, const QXxx &);
    QDataStream &operator>>(QDataStream &, QXxx &);

For example, here are the stream operators declared as non-members of the QImage class:

    QDataStream & operator<< (QDataStream& stream, const QImage& image);
    QDataStream & operator>> (QDataStream& stream, QImage& image);

To see if your favorite Qt class has similar stream operators defined, check the Related Non-Members section of the class's documentation page.

Using Read Transactions

When a data stream operates on an asynchronous device, the chunks of data can arrive at arbitrary points in time. The QDataStream class implements a transaction mechanism that provides the ability to read the data atomically with a series of stream operators. As an example, you can handle incomplete reads from a socket by using a transaction in a slot connected to the readyRead() signal:

in.startTransaction();
QString str;
qint32 a;
in >> str >> a; // try to read packet atomically

if (!in.commitTransaction())
    return;     // wait for more data

If no full packet is received, this code restores the stream to the initial position, after which you need to wait for more data to arrive.

Source: https://doc.qt.io/archives/qt-5.15/qdatastream.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
BigEndian attribute Any (shared captured text)
ByteOrder attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
DoublePrecision attribute Any (shared captured text)
FloatingPointPrecision attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
LittleEndian attribute Any (shared captured text)
Ok attribute Any (shared captured text)
Qt_1_0 attribute Any (shared captured text)
Qt_2_0 attribute Any (shared captured text)
Qt_2_1 attribute Any (shared captured text)
Qt_3_0 attribute Any (shared captured text)
Qt_3_1 attribute Any (shared captured text)
Qt_3_3 attribute Any (shared captured text)
Qt_4_0 attribute Any (shared captured text)
Qt_4_1 attribute Any (shared captured text)
Qt_4_2 attribute Any (shared captured text)
Qt_4_3 attribute Any (shared captured text)
Qt_4_4 attribute Any (shared captured text)
Qt_4_5 attribute Any (shared captured text)
Qt_4_6 attribute Any (shared captured text)
Qt_4_7 attribute Any (shared captured text)
Qt_4_8 attribute Any (shared captured text)
Qt_4_9 attribute Any (shared captured text)
Qt_5_0 attribute Any (shared captured text)
Qt_5_1 attribute Any (shared captured text)
Qt_5_2 attribute Any (shared captured text)
Qt_5_3 attribute Any (shared captured text)
Qt_5_4 attribute Any (shared captured text)
Qt_5_5 attribute Any (shared captured text)
Qt_5_6 attribute Any (shared captured text)
Qt_DefaultCompiledVersion attribute Any (shared captured text)
ReadCorruptData attribute Any (shared captured text)
ReadPastEnd attribute Any (shared captured text)
SinglePrecision attribute Any (shared captured text)
Status attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
Version attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
WriteFailed attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
atEnd function (self) -> bool X.atEnd() -> bool (shared captured text)
byteOrder function (self) -> Any Returns the current byte order setting -- either [BigEndian](https://doc.qt.io/archives/qt-5.15/qdatastream.html#ByteOrder-enum) or… (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
device function (self) -> Any X.device() -> PythonQt.QtCore.QIODevice (shared captured text)
floatingPointPrecision function (self) -> Any Returns the floating point precision of the data stream. (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
readBool function (self) -> bool X.readBool() -> bool (shared captured text)
readDouble function (self) -> float X.readDouble() -> float (shared captured text)
readFloat function (self) -> float X.readFloat() -> float (shared captured text)
readInt16 function (self) -> int X.readInt16() -> int (shared captured text)
readInt32 function (self) -> int X.readInt32() -> int (shared captured text)
readInt64 function (self) -> int X.readInt64() -> int (shared captured text)
readInt8 function (self) -> int X.readInt8() -> int (shared captured text)
readQChar function (self) -> str (shared captured text)
readQString function (self) -> str X.readQString() -> str (shared captured text)
readQStringList function (self) -> tuple X.readQStringList() -> tuple (shared captured text)
readQVariant function (self) -> Any X.readQVariant() -> object (shared captured text)
readRawData function (self, len: int) -> int Reads at most len bytes from the stream into s and returns the number of bytes read. (shared captured text)
readString function (self) -> str X.readString() -> str (shared captured text)
readUInt16 function (self) -> int X.readUInt16() -> int (shared captured text)
readUInt32 function (self) -> int X.readUInt32() -> int (shared captured text)
readUInt64 function (self) -> int X.readUInt64() -> int (shared captured text)
readUInt8 function (self) -> int X.readUInt8() -> int (shared captured text)
resetStatus function (self) -> None Resets the status of the data stream. (shared captured text)
setByteOrder function (self, arg__1: Any) -> None Sets the serialization byte order to bo. (shared captured text)
setDevice function (self, arg__1: Any) -> None Sets the I/O device to d, which can be nullptr to unset to current I/O device. (shared captured text)
setFloatingPointPrecision function (self, precision: Any) -> None Sets the floating point precision of the data stream to precision. (shared captured text)
setStatus function (self, status: Any) -> None Sets the status of the data stream to the status given. (shared captured text)
setVersion function (self, arg__1: int) -> None Sets the version number of the data serialization format to v, a value of the [Version](https://doc.qt.io/archives/qt-5.15/qdatastream.html#Version-enum) enum. (shared captured text)
skipRawData function (self, len: int) -> int X.skipRawData(len) -> int (shared captured text)
status function (self) -> Any Returns the status of the data stream. (shared captured text)
unsetDevice function (self) -> None (shared captured text)
version function (self) -> int X.version() -> int (shared captured text)
writeBool function (self, v: Any) -> None (shared captured text)
writeDouble function (self, v: Any) -> None (shared captured text)
writeFloat function (self, v: Any) -> None (shared captured text)
writeInt16 function (self, v: Any) -> None (shared captured text)
writeInt32 function (self, v: Any) -> None (shared captured text)
writeInt64 function (self, v: Any) -> None (shared captured text)
writeInt8 function (self, v: Any) -> None (shared captured text)
writeQChar function (self, v: Any) -> None (shared captured text)
writeQString function (self, v: Any) -> None (shared captured text)
writeQStringList function (self, v: Any) -> None (shared captured text)
writeQVariant function (self, v: Any) -> None (shared captured text)
writeRawData function (self, o: Any) -> int X.writeRawData(o) -> int (shared captured text)
writeString function (self, v: Any) -> None (shared captured text)
writeUInt16 function (self, v: Any) -> None (shared captured text)
writeUInt32 function (self, v: Any) -> None (shared captured text)
writeUInt64 function (self, v: Any) -> None (shared captured text)
writeUInt8 function (self, v: Any) -> None (shared captured text)