<QtEndian> - Endian Conversion Functions

The <QtEndian> header provides functions to convert between little and big endian representations of numbers. More...

Types

typedef qint16_be
typedef qint16_le
typedef qint32_be
typedef qint32_le
typedef qint64_be
typedef qint64_le
typedef quint16_be
typedef quint16_le
typedef quint32_be
typedef quint32_le
typedef quint64_be
typedef quint64_le

Functions

T qFromBigEndian(T src)
T qFromBigEndian(const void *src)
void qFromBigEndian(const void *src, qsizetype count, void *dest)
T qFromLittleEndian(T src)
T qFromLittleEndian(const void *src)
void qFromLittleEndian(const void *src, qsizetype count, void *dest)
T qToBigEndian(T src)
void qToBigEndian(T src, void *dest)
void qToBigEndian(const void *src, qsizetype count, void *dest)
T qToLittleEndian(T src)
void qToLittleEndian(T src, void *dest)
void qToLittleEndian(const void *src, qsizetype count, void *dest)

Type Documentation

typedef qint16_be

Typedef for QBEInteger<qint16>. This type is guaranteed to be stored in memory as a 16-bit big-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint16.

typedef qint16_le

Typedef for QLEInteger<qint16>. This type is guaranteed to be stored in memory as a 16-bit little-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint16.

typedef qint32_be

Typedef for QBEInteger<qint32>. This type is guaranteed to be stored in memory as a 32-bit big-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint32.

typedef qint32_le

Typedef for QLEInteger<qint32>. This type is guaranteed to be stored in memory as a 32-bit little-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint32.

typedef qint64_be

Typedef for QBEInteger<qint64>. This type is guaranteed to be stored in memory as a 64-bit big-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint64.

typedef qint64_le

Typedef for QLEInteger<qint64>. This type is guaranteed to be stored in memory as a 64-bit little-endian signed integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also qint64.

typedef quint16_be

Typedef for QBEInteger<quint16>. This type is guaranteed to be stored in memory as a 16-bit big-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint16.

typedef quint16_le

Typedef for QLEInteger<quint16>. This type is guaranteed to be stored in memory as a 16-bit little-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint16.

typedef quint32_be

Typedef for QBEInteger<quint32>. This type is guaranteed to be stored in memory as a 32-bit big-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint32.

typedef quint32_le

Typedef for QLEInteger<quint32>. This type is guaranteed to be stored in memory as a 32-bit little-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint32.

typedef quint64_be

Typedef for QBEInteger<quint64>. This type is guaranteed to be stored in memory as a 64-bit big-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint64.

typedef quint64_le

Typedef for QLEInteger<quint64>. This type is guaranteed to be stored in memory as a 64-bit little-endian unsigned integer on all platforms supported by Qt.

This typedef was introduced in Qt 5.10.

See also quint64.

Function Documentation

T qFromBigEndian(T src)

This is an overloaded function.

Converts src from big-endian byte order and returns the number in host byte order representation of that number. On CPU architectures where the host byte order is little-endian (such as x86) this will return src with the byte order swapped; otherwise it will return src unmodified.

This function was introduced in Qt 4.3.

T qFromBigEndian(const void *src)

Reads a big-endian number from memory location src and returns the number in the host byte order representation. On CPU architectures where the host byte order is little-endian (such as x86) this will swap the byte order; otherwise it will just read from src.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

Note: Since Qt 5.7, the type of the src parameter is a void pointer.

There are no data alignment constraints for src.

This function was introduced in Qt 4.3.

See also qFromLittleEndian(), qToBigEndian(), and qToLittleEndian().

void qFromBigEndian(const void *src, qsizetype count, void *dest)

Reads count big-endian numbers from memory location src and stores them in the host byte order representation at dest. On CPU architectures where the host byte order is little-endian (such as x86) this will swap the byte order; otherwise it will just perform a memcpy from src to dest.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for src. However, dest is expected to be naturally aligned for type T.

If src and dest can be the same pointer, this function will perform an in-place swap (if necessary). If they are not the same, the memory regions must not overlap.

This function was introduced in Qt 5.12.

See also qFromLittleEndian(), qToBigEndian(), and qToLittleEndian().

T qFromLittleEndian(T src)

This is an overloaded function.

Converts src from little-endian byte order and returns the number in host byte order representation of that number. On CPU architectures where the host byte order is big-endian (such as PowerPC) this will return src with the byte order swapped; otherwise it will return src unmodified.

This function was introduced in Qt 4.3.

T qFromLittleEndian(const void *src)

Reads a little-endian number from memory location src and returns the number in the host byte order representation. On CPU architectures where the host byte order is big-endian (such as PowerPC) this will swap the byte order; otherwise it will just read from src.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

Note: Since Qt 5.7, the type of the src parameter is a void pointer.

There are no data alignment constraints for src.

This function was introduced in Qt 4.3.

See also qFromBigEndian(), qToBigEndian(), and qToLittleEndian().

void qFromLittleEndian(const void *src, qsizetype count, void *dest)

Reads count little-endian numbers from memory location src and stores them in the host byte order representation at dest. On CPU architectures where the host byte order is big-endian (such as PowerPC) this will swap the byte order; otherwise it will just perform a memcpy from src to dest.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for src. However, dest is expected to be naturally aligned for type T.

If src and dest can be the same pointer, this function will perform an in-place swap (if necessary). If they are not the same, the memory regions must not overlap.

This function was introduced in Qt 5.12.

See also qFromLittleEndian(), qToBigEndian(), and qToLittleEndian().

T qToBigEndian(T src)

This is an overloaded function.

Converts src from host byte order and returns the number in big-endian byte order representation of that number. On CPU architectures where the host byte order is little-endian (such as x86) this will return src with the byte order swapped; otherwise it will return src unmodified.

This function was introduced in Qt 4.3.

void qToBigEndian(T src, void *dest)

Writes the number src with template type T to the memory location at dest in big-endian byte order.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for dest.

Note: Since Qt 5.7, the type of the dest parameter is a void pointer.

This function was introduced in Qt 4.3.

See also qFromBigEndian(), qFromLittleEndian(), and qToLittleEndian().

void qToBigEndian(const void *src, qsizetype count, void *dest)

Reads count numbers from memory location src in the host byte order and stores them in big-endian representation at dest. On CPU architectures where the host byte order is little-endian (such as x86) this will swap the byte order; otherwise it will just perform a memcpy from src to dest.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for dest. However, src is expected to be naturally aligned for type T.

If src and dest can be the same pointer, this function will perform an in-place swap (if necessary). If they are not the same, the memory regions must not overlap.

This function was introduced in Qt 5.12.

See also qFromLittleEndian(), qToBigEndian(), and qToLittleEndian().

T qToLittleEndian(T src)

This is an overloaded function.

Converts src from host byte order and returns the number in little-endian byte order representation of that number. On CPU architectures where the host byte order is big-endian (such as PowerPC) this will return src with the byte order swapped; otherwise it will return src unmodified.

This function was introduced in Qt 4.3.

void qToLittleEndian(T src, void *dest)

Writes the number src with template type T to the memory location at dest in little-endian byte order.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for dest.

Note: Since Qt 5.7, the type of the dest parameter is a void pointer.

This function was introduced in Qt 4.3.

See also qFromBigEndian(), qFromLittleEndian(), and qToBigEndian().

void qToLittleEndian(const void *src, qsizetype count, void *dest)

Reads count numbers from memory location src in the host byte order and stores them in little-endian representation at dest. On CPU architectures where the host byte order is big-endian (such as PowerPC) this will swap the byte order; otherwise it will just perform a memcpy from src to dest.

Note: Template type T can either be a quint16, qint16, quint32, qint32, quint64, or qint64. Other types of integers, e.g., qlong, are not applicable.

There are no data alignment constraints for dest. However, src is expected to be naturally aligned for type T.

If src and dest can be the same pointer, this function will perform an in-place swap (if necessary). If they are not the same, the memory regions must not overlap.

This function was introduced in Qt 5.12.

See also qFromLittleEndian(), qToBigEndian(), and qToLittleEndian().

© 2018 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.