QDebug Class

Member Function Documentation

Writes the string or string-view s to the stream and returns a reference to the stream.

These operators only participate in overload resolution if Char is one of

• char
• char8_t (C++20 only)
• char16_t
• char32_t
• wchar_t

This function was introduced in Qt 6.5.

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

Constructs a debug stream that writes to the given device.

[explicit] QDebug::QDebug(QString *string)

Constructs a debug stream that writes to the given string.

[explicit] QDebug::QDebug(QtMsgType t)

Constructs a debug stream that writes to the handler for the message type t.

QDebug::QDebug(const QDebug &o)

Constructs a copy of the other debug stream o.

QDebug::~QDebug()

Flushes any pending data to be written and destroys the debug stream.

bool QDebug::autoInsertSpaces() const

Returns true if this QDebug instance will automatically insert spaces between writes.

See also setAutoInsertSpaces() and QDebugStateSaver.

QDebug &QDebug::maybeQuote(char c = '"')

Writes a character c to the debug stream, depending on the current setting for automatic insertion of quotes, and returns a reference to the stream.

The default character is a double quote ".

See also quote() and noquote().

QDebug &QDebug::maybeSpace()

Writes a space character to the debug stream, depending on the current setting for automatic insertion of spaces, and returns a reference to the stream.

See also space() and nospace().

QDebug &QDebug::noquote()

Disables automatic insertion of quotation characters around QChar, QString and QByteArray contents and returns a reference to the stream.

When quoting is disabled, these types are printed without quotation characters and without escaping of non-printable characters.

See also quote() and maybeQuote().

QDebug &QDebug::nospace()

Disables automatic insertion of spaces and returns a reference to the stream.

See also space() and maybeSpace().

QDebug &QDebug::quote()

Enables automatic insertion of quotation characters around QChar, QString and QByteArray contents and returns a reference to the stream.

Quoting is enabled by default.

See also noquote() and maybeQuote().

QDebug &QDebug::resetFormat()

Resets the stream formatting options, bringing it back to its original constructed state.

See also space() and quote().

void QDebug::setAutoInsertSpaces(bool b)

Enables automatic insertion of spaces between writes if b is true; otherwise automatic insertion of spaces is disabled.

See also autoInsertSpaces() and QDebugStateSaver.

void QDebug::setVerbosity(int verbosityLevel)

Sets the verbosity of the stream to verbosityLevel.

The allowed range is from 0 to 7. The default value is 2.

See also verbosity() and VerbosityLevel.

QDebug &QDebug::space()

Writes a space character to the debug stream and returns a reference to the stream.

The stream remembers that automatic insertion of spaces is enabled for future writes.

See also nospace() and maybeSpace().

void QDebug::swap(QDebug &other)

Swaps this debug stream instance with other. This operation is very fast and never fails.

[static, since 6.0] template <typename T> QString QDebug::toString(T &&object)

Streams object into a QDebug instance that operates on a string, and then returns that string.

This function is useful for cases where you need the textual representation of an object for debugging, but cannot use operator<<. For example:

    QTRY_VERIFY2(list.isEmpty(), qPrintable(QString::fromLatin1(
        "Expected list to be empty, but it has the following items: %1")).arg(QDebug::toString(list)));

The string is streamed using nospace().

This function was introduced in Qt 6.0.

QDebug &QDebug::verbosity(int verbosityLevel)

Sets the verbosity of the stream to verbosityLevel and returns a reference to the stream.

The allowed range is from 0 to 7. The default value is 2.

See also verbosity(), setVerbosity(), and VerbosityLevel.

int QDebug::verbosity() const

Returns the verbosity of the debug stream.

Streaming operators can check the value to decide whether verbose output is desired and print more information depending on the level. Higher values indicate that more information is desired.

The allowed range is from 0 to 7. The default value is 2.

See also setVerbosity() and VerbosityLevel.

QDebug &QDebug::operator<<(QChar t)

Writes the character, t, to the stream and returns a reference to the stream. Normally, QDebug prints control characters and non-US-ASCII characters as their C escape sequences or their Unicode value (\u1234). To print non-printable characters without transformation, enable the noquote() functionality, but note that some QDebug backends may not be 8-bit clean and may not be able to represent t.

QDebug &QDebug::operator<<(bool t)

Writes the boolean value, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(char t)

Writes the character, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(short t)

Writes the signed short integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(unsigned short t)

Writes then unsigned short integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(char16_t t)

Writes the UTF-16 character, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(char32_t t)

Writes the UTF-32 character, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(int t)

Writes the signed integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(unsigned int t)

Writes then unsigned integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(long t)

Writes the signed long integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(unsigned long t)

Writes then unsigned long integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(qint64 t)

Writes the signed 64-bit integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(quint64 t)

Writes then unsigned 64-bit integer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(float t)

Writes the 32-bit floating point number, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(double t)

Writes the 64-bit floating point number, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator<<(const char *t)

Writes the '\0'-terminated UTF-8 string, t, to the stream and returns a reference to the stream. The string is never quoted or escaped for the output. Note that QDebug buffers internally as UTF-16 and may need to transform to 8-bit using the locale's codec in order to use some backends, which may cause garbled output (mojibake). Restricting to US-ASCII strings is recommended.

[since 6.0] QDebug &QDebug::operator<<(const char16_t *t)

Writes the u'\0'-terminated UTF-16 string, t, to the stream and returns a reference to the stream. The string is never quoted or escaped for the output. Note that QDebug buffers internally as UTF-16 and may need to transform to 8-bit using the locale's codec in order to use some backends, which may cause garbled output (mojibake). Restricting to US-ASCII strings is recommended.

This function was introduced in Qt 6.0.

QDebug &QDebug::operator<<(const QString &t)

Writes the string, t, to the stream and returns a reference to the stream. Normally, QDebug prints the string inside quotes and transforms non-printable characters to their Unicode values (\u1234).

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

Output examples:

    QString s;

    s = "a";
    qDebug().noquote() << s;    // prints: a
    qDebug() << s;              // prints: "a"

    s = "\"a\r\n\"";
    qDebug() << s;              // prints: "\"a\r\n\""

    s = "\033";                 // escape character
    qDebug() << s;              // prints: "\u001B"

    s = "\u00AD";               // SOFT HYPHEN
    qDebug() << s;              // prints: "\u00AD"

    s = "\u00E1";               // LATIN SMALL LETTER A WITH ACUTE
    qDebug() << s;              // prints: "á"

    s = "a\u0301";              // "a" followed by COMBINING ACUTE ACCENT
    qDebug() << s;              // prints: "á";

    s = "\u0430\u0301";         // CYRILLIC SMALL LETTER A followed by COMBINING ACUTE ACCENT
    qDebug() << s;              // prints: "а́"

QDebug &QDebug::operator<<(QStringView s)

Writes the string view, s, to the stream and returns a reference to the stream. Normally, QDebug prints the string inside quotes and transforms non-printable characters to their Unicode values (\u1234).

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

See the QString overload for examples.

[since 6.0] QDebug &QDebug::operator<<(QUtf8StringView s)

Writes the string view, s, to the stream and returns a reference to the stream.

Normally, QDebug prints the data inside quotes and transforms control or non-US-ASCII characters to their C escape sequences (\xAB). This way, the output is always 7-bit clean and the string can be copied from the output and pasted back into C++ sources, if necessary.

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

This function was introduced in Qt 6.0.

QDebug &QDebug::operator<<(QLatin1StringView t)

Writes the string, t, to the stream and returns a reference to the stream. Normally, QDebug prints the string inside quotes and transforms non-printable characters to their Unicode values (\u1234).

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

See the QString overload for examples.

QDebug &QDebug::operator<<(const QByteArray &t)

Writes the byte array, t, to the stream and returns a reference to the stream. Normally, QDebug prints the array inside quotes and transforms control or non-US-ASCII characters to their C escape sequences (\xAB). This way, the output is always 7-bit clean and the string can be copied from the output and pasted back into C++ sources, if necessary.

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

Output examples:

    QByteArray ba;

    ba = "a";
    qDebug().noquote() << ba;    // prints: a
    qDebug() << ba;              // prints: "a"

    ba = "\"a\r\n\"";
    qDebug() << ba;              // prints: "\"a\r\n\""

    ba = "\033";                 // escape character
    qDebug() << ba;              // prints: "\x1B"

    ba = "\xC3\xA1";
    qDebug() << ba;              // prints: "\xC3\xA1"

    ba = QByteArray("a\0b", 3);
    qDebug() << ba               // prints: "\a\x00""b"

Note how QDebug needed to close and reopen the string in the way C and C++ languages concatenate string literals so that the letter 'b' is not interpreted as part of the previous hexadecimal escape sequence.

[since 6.0] QDebug &QDebug::operator<<(QByteArrayView t)

Writes the data of the observed byte array, t, to the stream and returns a reference to the stream.

Normally, QDebug prints the data inside quotes and transforms control or non-US-ASCII characters to their C escape sequences (\xAB). This way, the output is always 7-bit clean and the string can be copied from the output and pasted back into C++ sources, if necessary.

To print non-printable characters without transformation, enable the noquote() functionality. Note that some QDebug backends might not be 8-bit clean.

See the QByteArray overload for examples.

This function was introduced in Qt 6.0.

QDebug &QDebug::operator<<(const void *t)

Writes a pointer, t, to the stream and returns a reference to the stream.

QDebug &QDebug::operator=(const QDebug &other)

Assigns the other debug stream to this stream and returns a reference to this stream.