|  | Home · All Classes · Modules

# QIODevice Class Reference
[QtCore module]

The QIODevice class is the base interface class of all I/O devices in Qt. More...

Inherits QObject.

Inherited by QAbstractSocket, QBuffer, QFile, QLocalSocket, QNetworkReply and QProcess.

### Types

- class OpenMode
- enum OpenModeFlag { NotOpen, ReadOnly, WriteOnly, ReadWrite, ..., Unbuffered }

### Methods

- __init__ (self)
- __init__ (self, QObject parent)
- bool atEnd (self)
- int bytesAvailable (self)
- int bytesToWrite (self)
- bool canReadLine (self)
- close (self)
- QString errorString (self)
- (bool, str c) getChar (self)
- bool isOpen (self)
- bool isReadable (self)
- bool isSequential (self)
- bool isTextModeEnabled (self)
- bool isWritable (self)
- bool open (self, OpenMode mode)
- OpenMode openMode (self)
- QByteArray peek (self, int maxlen)
- int pos (self)
- bool putChar (self, str c)
- object read (self, int maxlen)
- QByteArray readAll (self)
- object readData (self, int maxlen)
- object readLine (self, int maxlen = 0)
- object readLineData (self, int maxlen)
- bool reset (self)
- bool seek (self, int pos)
- setErrorString (self, QString errorString)
- setOpenMode (self, OpenMode openMode)
- setTextModeEnabled (self, bool enabled)
- int size (self)
- ungetChar (self, str c)
- bool waitForBytesWritten (self, int msecs)
- bool waitForReadyRead (self, int msecs)
- int write (self, QByteArray data)
- int writeData (self, bytes data)

### Qt Signals

- void aboutToClose ()
- void bytesWritten ( ::qint64)
- void readChannelFinished ()
- void readyRead ()

## Detailed Description

The QIODevice class is the base interface class of all I/O devices in Qt.

QIODevice provides both a common implementation and an abstract interface for devices that support reading and writing of blocks of data, such as QFile, QBuffer and QTcpSocket. QIODevice is abstract and can not be instantiated, but it is common to use the interface it defines to provide device-independent I/O features. For example, Qt's XML classes operate on a QIODevice pointer, allowing them to be used with various devices (such as files and buffers).

Before accessing the device, open() must be called to set the correct OpenMode (such as ReadOnly or ReadWrite). You can then write to the device with write() or putChar(), and read by calling either read(), readLine(), or readAll(). Call close() when you are done with the device.

QIODevice distinguishes between two types of devices: random-access devices and sequential devices.

- Random-access devices support seeking to arbitrary positions using seek(). The current position in the file is available by calling pos(). QFile and QBuffer are examples of random-access devices.
- Sequential devices don't support seeking to arbitrary positions. The data must be read in one pass. The functions pos() and size() don't work for sequential devices. QTcpSocket and QProcess are examples of sequential devices.

You can use isSequential() to determine the type of device.

QIODevice emits readyRead() when new data is available for reading; for example, if new data has arrived on the network or if additional data is appended to a file that you are reading from. You can call bytesAvailable() to determine the number of bytes that are currently available for reading. It's common to use bytesAvailable() together with the readyRead() signal when programming with asynchronous devices such as QTcpSocket, where fragments of data can arrive at arbitrary points in time. QIODevice emits the bytesWritten() signal every time a payload of data has been written to the device. Use bytesToWrite() to determine the current amount of data waiting to be written.

Certain subclasses of QIODevice, such as QTcpSocket and QProcess, are asynchronous. This means that I/O functions such as write() or read() always return immediately, while communication with the device itself may happen when control goes back to the event loop. QIODevice provides functions that allow you to force these operations to be performed immediately, while blocking the calling thread and without entering the event loop. This allows QIODevice subclasses to be used without an event loop, or in a separate thread:

- waitForReadyRead() - This function suspends operation in the calling thread until new data is available for reading.
- waitForBytesWritten() - This function suspends operation in the calling thread until one payload of data has been written to the device.
- waitFor....() - Subclasses of QIODevice implement blocking functions for device-specific operations. For example, QProcess has a function called waitForStarted() which suspends operation in the calling thread until the process has started.

Calling these functions from the main, GUI thread, may cause your user interface to freeze. Example:

     QProcess gzip;
     gzip.start("gzip", QStringList() << "-c");
     if (!gzip.waitForStarted())
         return false;

     gzip.write("uncompressed data");

     QByteArray compressed;
     while (gzip.waitForReadyRead())
         compressed += gzip.readAll();

By subclassing QIODevice, you can provide the same interface to your own I/O devices. Subclasses of QIODevice are only required to implement the protected readData() and writeData() functions. QIODevice uses these functions to implement all its convenience functions, such as getChar(), readLine() and write(). QIODevice also handles access control for you, so you can safely assume that the device is opened in write mode if writeData() is called.

Some subclasses, such as QFile and QTcpSocket, are implemented using a memory buffer for intermediate storing of data. This reduces the number of required device accessing calls, which are often very slow. Buffering makes functions like getChar() and putChar() fast, as they can operate on the memory buffer instead of directly on the device itself. Certain I/O operations, however, don't work well with a buffer. For example, if several users open the same device and read it character by character, they may end up reading the same data when they meant to read a separate chunk each. For this reason, QIODevice allows you to bypass any buffering by passing the Unbuffered flag to open(). When subclassing QIODevice, remember to bypass any buffer you may use when the device is open in Unbuffered mode.

## Type Documentation

### QIODevice.OpenModeFlag

This enum is used with open() to describe the mode in which a device is opened. It is also returned by openMode().

Constant | Value | Description
--- | --- | ---
`QIODevice.NotOpen` | `0x0000` | The device is not open.
`QIODevice.ReadOnly` | `0x0001` | The device is open for reading.
`QIODevice.WriteOnly` | `0x0002` | The device is open for writing.
`QIODevice.ReadWrite` | `ReadOnly | WriteOnly` | The device is open for reading and writing.
`QIODevice.Append` | `0x0004` | The device is opened in append mode, so that all data is written to the end of the file.
`QIODevice.Truncate` | `0x0008` | If possible, the device is truncated before it is opened. All earlier contents of the device are lost.
`QIODevice.Text` | `0x0010` | When reading, the end-of-line terminators are translated to '\n'. When writing, the end-of-line terminators are translated to the local encoding, for example '\r\n' for Win32.
`QIODevice.Unbuffered` | `0x0020` | Any buffer in the device is bypassed.

Certain flags, such as `Unbuffered` and `Truncate`, are meaningless when used with some subclasses. Some of these restrictions are implied by the type of device that is represented by a subclass. In other cases, the restriction may be due to the implementation, or may be imposed by the underlying platform; for example, QTcpSocket does not support `Unbuffered` mode, and limitations in the native API prevent QFile from supporting `Unbuffered` on Windows.

The OpenMode type is a typedef for QFlags<OpenModeFlag>. It stores an OR combination of OpenModeFlag values.

## Method Documentation

### QIODevice.__init__ (self)

Constructs a QIODevice object.

### QIODevice.__init__ (self, QObject parent)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a QIODevice object with the given parent.

### bool QIODevice.atEnd (self)

Returns true if the current read and write position is at the end of the device (i.e. there is no more data available for reading on the device); otherwise returns false.

For some devices, atEnd() can return true even though there is more data to read. This special case only applies to devices that generate data in direct response to you calling read() (e.g., `/dev` or `/proc` files on Unix and Mac OS X, or console input / `stdin` on all platforms).

See also bytesAvailable(), read(), and isSequential().

### int QIODevice.bytesAvailable (self)

Returns the number of bytes that are available for reading. This function is commonly used with sequential devices to determine the number of bytes to allocate in a buffer before reading.

Subclasses that reimplement this function must call the base implementation in order to include the size of QIODevices' buffer. Example:

     long CustomDevice.bytesAvailable() const
     {
         return buffer.size() + QIODevice.bytesAvailable();
     }

See also bytesToWrite(), readyRead(), and isSequential().

### int QIODevice.bytesToWrite (self)

For buffered devices, this function returns the number of bytes waiting to be written. For devices with no buffer, this function returns 0.

See also bytesAvailable(), bytesWritten(), and isSequential().

### bool QIODevice.canReadLine (self)

Returns true if a complete line of data can be read from the device; otherwise returns false.

Note that unbuffered devices, which have no way of determining what can be read, always return false.

This function is often called in conjunction with the readyRead() signal.

Subclasses that reimplement this function must call the base implementation in order to include the contents of the QIODevice's buffer. Example:

     bool CustomDevice.canReadLine() const
     {
         return buffer.contains('\n') || QIODevice.canReadLine();
     }

See also readyRead() and readLine().

### QIODevice.close (self)

First emits aboutToClose(), then closes the device and sets its OpenMode to NotOpen. The error string is also reset.

See also setOpenMode() and OpenMode.

### QString QIODevice.errorString (self)

Returns a human-readable description of the last device error that occurred.

See also setErrorString().

### (bool, str c) QIODevice.getChar (self)

Reads one character from the device and stores it in c. If c is 0, the character is discarded. Returns true on success; otherwise returns false.

See also read(), putChar(), and ungetChar().

### bool QIODevice.isOpen (self)

Returns true if the device is open; otherwise returns false. A device is open if it can be read from and/or written to. By default, this function returns false if openMode() returns `NotOpen`.

See also openMode() and OpenMode.

### bool QIODevice.isReadable (self)

Returns true if data can be read from the device; otherwise returns false. Use bytesAvailable() to determine how many bytes can be read.

This is a convenience function which checks if the OpenMode of the device contains the ReadOnly flag.

See also openMode() and OpenMode.

### bool QIODevice.isSequential (self)

Returns true if this device is sequential; otherwise returns false.

Sequential devices, as opposed to a random-access devices, have no concept of a start, an end, a size, or a current position, and they do not support seeking. You can only read from the device when it reports that data is available. The most common example of a sequential device is a network socket. On Unix, special files such as /dev/zero and fifo pipes are sequential.

Regular files, on the other hand, do support random access. They have both a size and a current position, and they also support seeking backwards and forwards in the data stream. Regular files are non-sequential.

The QIODevice implementation returns false.

See also bytesAvailable().

### bool QIODevice.isTextModeEnabled (self)

Returns true if the Text flag is enabled; otherwise returns false.

See also setTextModeEnabled().

### bool QIODevice.isWritable (self)

Returns true if data can be written to the device; otherwise returns false.

This is a convenience function which checks if the OpenMode of the device contains the WriteOnly flag.

See also openMode() and OpenMode.

### bool QIODevice.open (self, OpenMode mode)

Opens the device and sets its OpenMode to mode. Returns true if successful; otherwise returns false. This function should be called from any reimplementations of open() or other functions that open the device.

See also openMode() and OpenMode.

### OpenMode QIODevice.openMode (self)

Returns the mode in which the device has been opened; i.e. ReadOnly or WriteOnly.

See also setOpenMode() and OpenMode.

### QByteArray QIODevice.peek (self, int maxlen)

Reads at most maxSize bytes from the device into data, without side effects (i.e., if you call read() after peek(), you will get the same data). Returns the number of bytes read. If an error occurs, such as when attempting to peek a device opened in WriteOnly mode, this function returns -1.

0 is returned when no more data is available for reading.

Example:

     bool isExeFile(QFile *file)
     {
         char buf[2];
         if (file->peek(buf, sizeof(buf)) == sizeof(buf))
             return (buf[0] == 'M' && buf[1] == 'Z');
         return false;
     }

This function was introduced in Qt 4.1.

See also read().

### int QIODevice.pos (self)

For random-access devices, this function returns the position that data is written to or read from. For sequential devices or closed devices, where there is no concept of a "current position", 0 is returned.

The current read/write position of the device is maintained internally by QIODevice, so reimplementing this function is not necessary. When subclassing QIODevice, use QIODevice.seek() to notify QIODevice about changes in the device position.

See also isSequential() and seek().

### bool QIODevice.putChar (self, str c)

Writes the character c to the device. Returns true on success; otherwise returns false.

See also write(), getChar(), and ungetChar().

### object QIODevice.read (self, int maxlen)

Reads at most maxSize bytes from the device into data, and returns the number of bytes read. If an error occurs, such as when attempting to read from a device opened in WriteOnly mode, this function returns -1.

0 is returned when no more data is available for reading. However, reading past the end of the stream is considered an error, so this function returns -1 in those cases (that is, reading on a closed socket or after a process has died).

See also readData(), readLine(), and write().

### QByteArray QIODevice.readAll (self)

This is an overloaded function.

Reads all available data from the device, and returns it as a QByteArray.

This function has no way of reporting errors; returning an empty QByteArray() can mean either that no data was currently available for reading, or that an error occurred.

### object QIODevice.readData (self, int maxlen)

This method is abstract and should be reimplemented in any sub-class.

Reads up to maxSize bytes from the device into data, and returns the number of bytes read or -1 if an error occurred.

If there are no bytes to be read and there can never be more bytes available (examples include socket closed, pipe closed, sub-process finished), this function returns -1.

This function is called by QIODevice. Reimplement this function when creating a subclass of QIODevice.

When reimplementing this function it is important that this function reads all the required data before returning. This is required in order for QDataStream to be able to operate on the class. QDataStream assumes all the requested information was read and therefore does not retry reading if there was a problem.

See also read(), readLine(), and writeData().

### object QIODevice.readLine (self, int maxlen = 0)

This function reads a line of ASCII characters from the device, up to a maximum of maxSize - 1 bytes, stores the characters in data, and returns the number of bytes read. If a line could not be read but no error ocurred, this function returns 0. If an error occurs, this function returns the length of what could be read, or -1 if nothing was read.

A terminating '\0' byte is always appended to data, so maxSize must be larger than 1.

Data is read until either of the following conditions are met:

- The first '\n' character is read.
- maxSize - 1 bytes are read.
- The end of the device data is detected.

For example, the following code reads a line of characters from a file:

     QFile file("box.txt");
     if (file.open(QFile.ReadOnly)) {
         char buf[1024];
         long lineLength = file.readLine(buf, sizeof(buf));
         if (lineLength != -1) {
             // the line is available in buf
         }
     }

The newline character ('\n') is included in the buffer. If a newline is not encountered before maxSize - 1 bytes are read, a newline will not be inserted into the buffer. On windows newline characters are replaced with '\n'.

This function calls readLineData(), which is implemented using repeated calls to getChar(). You can provide a more efficient implementation by reimplementing readLineData() in your own subclass.

See also getChar(), read(), and write().

### object QIODevice.readLineData (self, int maxlen)

Reads up to maxSize characters into data and returns the number of characters read.

This function is called by readLine(), and provides its base implementation, using getChar(). Buffered devices can improve the performance of readLine() by reimplementing this function.

readLine() appends a '\0' byte to data; readLineData() does not need to do this.

If you reimplement this function, be careful to return the correct value: it should return the number of bytes read in this line, including the terminating newline, or 0 if there is no line to be read at this point. If an error occurs, it should return -1 if and only if no bytes were read. Reading past EOF is considered an error.

### bool QIODevice.reset (self)

Seeks to the start of input for random-access devices. Returns true on success; otherwise returns false (for example, if the device is not open).

Note that when using a QTextStream on a QFile, calling reset() on the QFile will not have the expected result because QTextStream buffers the file. Use the QTextStream.seek() function instead.

See also seek().

### bool QIODevice.seek (self, int pos)

For random-access devices, this function sets the current position to pos, returning true on success, or false if an error occurred. For sequential devices, the default behavior is to do nothing and return false.

When subclassing QIODevice, you must call QIODevice.seek() at the start of your function to ensure integrity with QIODevice's built-in buffer. The base implementation always returns true.

See also pos() and isSequential().

### QIODevice.setErrorString (self, QString errorString)

Sets the human readable description of the last device error that occurred to str.

See also errorString().

### QIODevice.setOpenMode (self, OpenMode openMode)

Sets the OpenMode of the device to openMode. Call this function to set the open mode if the flags change after the device has been opened.

See also openMode() and OpenMode.

### QIODevice.setTextModeEnabled (self, bool enabled)

If enabled is true, this function sets the Text flag on the device; otherwise the Text flag is removed. This feature is useful for classes that provide custom end-of-line handling on a QIODevice.

The IO device should be opened before calling this function.

See also isTextModeEnabled(), open(), and setOpenMode().

### int QIODevice.size (self)

For open random-access devices, this function returns the size of the device. For open sequential devices, bytesAvailable() is returned.

If the device is closed, the size returned will not reflect the actual size of the device.

See also isSequential() and pos().

### QIODevice.ungetChar (self, str c)

Puts the character c back into the device, and decrements the current position unless the position is 0. This function is usually called to "undo" a getChar() operation, such as when writing a backtracking parser.

If c was not previously read from the device, the behavior is undefined.

### bool QIODevice.waitForBytesWritten (self, int msecs)

For buffered devices, this function waits until a payload of buffered written data has been written to the device and the bytesWritten() signal has been emitted, or until msecs milliseconds have passed. If msecs is -1, this function will not time out. For unbuffered devices, it returns immediately.

Returns true if a payload of data was written to the device; otherwise returns false (i.e. if the operation timed out, or if an error occurred).

This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.

If called from within a slot connected to the bytesWritten() signal, bytesWritten() will not be reemitted.

Reimplement this function to provide a blocking API for a custom device. The default implementation does nothing, and returns false.

Warning: Calling this function from the main (GUI) thread might cause your user interface to freeze.

See also waitForReadyRead().

### bool QIODevice.waitForReadyRead (self, int msecs)

Blocks until new data is available for reading and the readyRead() signal has been emitted, or until msecs milliseconds have passed. If msecs is -1, this function will not time out.

Returns true if new data is available for reading; otherwise returns false (if the operation timed out or if an error occurred).

This function can operate without an event loop. It is useful when writing non-GUI applications and when performing I/O operations in a non-GUI thread.

If called from within a slot connected to the readyRead() signal, readyRead() will not be reemitted.

Reimplement this function to provide a blocking API for a custom device. The default implementation does nothing, and returns false.

Warning: Calling this function from the main (GUI) thread might cause your user interface to freeze.

See also waitForBytesWritten().

### int QIODevice.write (self, QByteArray data)

Writes at most maxSize bytes of data from data to the device. Returns the number of bytes that were actually written, or -1 if an error occurred.

See also read() and writeData().

### int QIODevice.writeData (self, bytes data)

This method is abstract and should be reimplemented in any sub-class.

Writes up to maxSize bytes from data to the device. Returns the number of bytes written, or -1 if an error occurred.

This function is called by QIODevice. Reimplement this function when creating a subclass of QIODevice.

When reimplementing this function it is important that this function writes all the data available before returning. This is required in order for QDataStream to be able to operate on the class. QDataStream assumes all the information was written and therefore does not retry writing if there was a problem.

See also read() and write().

## Qt Signal Documentation

### void aboutToClose ()

This is the default overload of this signal.

This signal is emitted when the device is about to close. Connect this signal if you have operations that need to be performed before the device closes (e.g., if you have data in a separate buffer that needs to be written to the device).

### void bytesWritten ( ::qint64)

This is the default overload of this signal.

This signal is emitted every time a payload of data has been written to the device. The bytes argument is set to the number of bytes that were written in this payload.

bytesWritten() is not emitted recursively; if you reenter the event loop or call waitForBytesWritten() inside a slot connected to the bytesWritten() signal, the signal will not be reemitted (although waitForBytesWritten() may still return true).

See also readyRead().

### void readChannelFinished ()

This is the default overload of this signal.

This signal is emitted when the input (reading) stream is closed in this device. It is emitted as soon as the closing is detected, which means that there might still be data available for reading with read().

This function was introduced in Qt 4.4.

See also atEnd() and read().

### void readyRead ()

This is the default overload of this signal.

This signal is emitted once every time new data is available for reading from the device. It will only be emitted again once new data is available, such as when a new payload of network data has arrived on your network socket, or when a new block of data has been appended to your device.

readyRead() is not emitted recursively; if you reenter the event loop or call waitForReadyRead() inside a slot connected to the readyRead() signal, the signal will not be reemitted (although waitForReadyRead() may still return true).

Note for developers implementing classes derived from QIODevice: you should always emit readyRead() when new data has arrived (do not emit it only because there's data still to be read in your buffers). Do not emit readyRead() in other conditions.

See also bytesWritten().