QDataStream Class

Documentation des fonctions membres

QDataStream::QDataStream()

Construit un flux de données qui n'a pas de périphérique d'entrée/sortie.

Voir aussi setDevice().

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

Construit un flux de données qui utilise le périphérique d'E/S d.

Voir également setDevice() et device().

QDataStream::QDataStream(const QByteArray &a)

Construit un flux de données en lecture seule qui opère sur un tableau d'octets a. Utilisez QDataStream(QByteArray*, int) si vous souhaitez écrire dans un tableau d'octets.

Comme QByteArray n'est pas une sous-classe de QIODevice, une QBuffer est créée en interne pour envelopper le tableau d'octets.

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

Construit un flux de données qui opère sur un tableau d'octets, a. Le site mode décrit la manière dont le périphérique doit être utilisé.

Vous pouvez également utiliser QDataStream(const QByteArray &) si vous souhaitez simplement lire un tableau d'octets.

Comme QByteArray n'est pas une sous-classe de QIODevice, une QBuffer est créée en interne pour envelopper le tableau d'octets.

[noexcept] QDataStream::~QDataStream()

Détruit le flux de données.

Le destructeur n'affecte pas le périphérique d'E/S actuel, sauf s'il s'agit d'un périphérique d'E/S interne (par exemple, un QBuffer) traitant un QByteArray transmis dans le constructeur, auquel cas le périphérique d'E/S interne est détruit.

void QDataStream::abortTransaction()

Abandonne une transaction de lecture.

Cette fonction est généralement utilisée pour abandonner la transaction après des erreurs de protocole de niveau supérieur ou une perte de synchronisation des flux.

Si elle est appelée sur une transaction interne, l'abandon est délégué à la transaction la plus externe, et les transactions internes démarrées ultérieurement sont forcées d'échouer.

Pour la transaction externe, le point de restauration et toutes les données dupliquées en interne dans le flux sont supprimés. N'affecte pas la position de lecture actuelle du flux.

Définit l'état du flux de données à

Voir également startTransaction(), commitTransaction() et rollbackTransaction().

bool QDataStream::atEnd() const

Renvoie true si le périphérique d'E/S a atteint la position de fin (fin du flux ou du fichier) ou si aucun périphérique d'E/S n'est défini ; sinon, renvoie false.

Voir aussi QIODevice::atEnd().

QDataStream::ByteOrder QDataStream::byteOrder() const

Renvoie l'ordre actuel des octets - soit BigEndian ou LittleEndian.

Voir aussi setByteOrder().

bool QDataStream::commitTransaction()

Termine une transaction de lecture. Retourne true si aucune erreur de lecture ne s'est produite pendant la transaction ; sinon, retourne false.

Si elle est appelée sur une transaction interne, la validation sera reportée jusqu'à ce que l'appel commitTransaction(), rollbackTransaction() ou abortTransaction() le plus éloigné se produise.

Dans le cas contraire, si l'état du flux indique que la lecture a dépassé la fin des données, cette fonction restaure les données du flux au moment de l'appel à startTransaction(). Dans ce cas, vous devez attendre que d'autres données arrivent, après quoi vous commencez une nouvelle transaction. Si le flux de données a lu des données corrompues ou si l'une des transactions internes a été interrompue, cette fonction interrompt la transaction.

Voir également startTransaction(), rollbackTransaction() et abortTransaction().

QIODevice *QDataStream::device() const

Renvoie le périphérique d'E/S actuellement défini, ou nullptr si aucun périphérique n'est actuellement défini.

Voir aussi setDevice().

QDataStream::FloatingPointPrecision QDataStream::floatingPointPrecision() const

Renvoie la précision en virgule flottante du flux de données.

Voir aussi FloatingPointPrecision et setFloatingPointPrecision().

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

Lit le tampon s dans le flux et renvoie une référence au flux.

Le tampon s est alloué à l'aide de new []. Il peut être détruit à l'aide de l'opérateur delete [].

Le paramètre l correspond à la longueur du tampon. Si la chaîne lue est vide, l est mis à 0 et s est mis à nullptr.

Le format de sérialisation est un spécificateur de longueur d'abord, puis l octets de données. Le spécificateur de longueur est un quint32 si la version est inférieure à 6.7 ou si le nombre d'éléments est inférieur à 0xfffffe (2^32 -2), sinon il y a une valeur d'extension 0xfffffe suivie d'un quint64 avec la valeur réelle. De plus, pour les conteneurs qui supportent isNull(), il est encodé comme un simple quint32 avec tous les bits définis et aucune donnée.

Cette fonction a été introduite dans Qt 6.7.

Voir aussi readRawData() et writeBytes().

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

Lit au maximum len octets du flux dans s et renvoie le nombre d'octets lus. En cas d'erreur, cette fonction renvoie -1.

Le tampon s doit être pré-alloué. Les données ne sont pas décodées.

Voir aussi readBytes(), QIODevice::read() et writeRawData().

void QDataStream::resetStatus()

Réinitialise l'état du flux de données.

Voir aussi Status, status(), et setStatus().

void QDataStream::rollbackTransaction()

Annule une transaction de lecture.

Cette fonction est généralement utilisée pour annuler la transaction lorsqu'une lecture incomplète a été détectée avant la validation de la transaction.

Si elle est appelée sur une transaction interne, l'annulation est déléguée à la transaction externe, et les transactions internes démarrées ultérieurement sont forcées d'échouer.

Pour la transaction externe, rétablit les données du flux au point de l'appel à startTransaction(). Si le flux de données a lu des données corrompues ou si l'une des transactions internes a été interrompue, cette fonction interrompt la transaction.

Si les opérations précédentes sur le flux ont réussi, cette fonction définit l'état du flux de données à

Voir également startTransaction(), commitTransaction() et abortTransaction().

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

Définit l'ordre des octets de la sérialisation à bo.

Le paramètre bo peut être QDataStream::BigEndian ou QDataStream::LittleEndian.

Le paramètre par défaut est big-endian. Nous recommandons de laisser ce paramètre à moins que vous n'ayez des exigences particulières.

Voir aussi byteOrder().

void QDataStream::setDevice(QIODevice *d)

void QDataStream::setDevice(QIODevice *d)

Définit le périphérique d'E/S à d, qui peut être nullptr pour annuler le périphérique d'E/S actuel.

Voir également device().

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

Définit la précision de la virgule flottante du flux de données à precision. Si la précision de la virgule flottante est DoublePrecision et que la version du flux de données est Qt_4_6 ou supérieure, tous les nombres à virgule flottante seront écrits et lus avec une précision de 64 bits. Si la précision de la virgule flottante est SinglePrecision et que la version est Qt_4_6 ou supérieure, tous les nombres à virgule flottante seront écrits et lus avec une précision de 32 bits.

Pour les versions antérieures à Qt_4_6, la précision des nombres à virgule flottante dans le flux de données dépend de l'opérateur de flux appelé.

La valeur par défaut est DoublePrecision.

Notez que cette propriété n'affecte pas la sérialisation ou la désérialisation des instances qfloat16.

Voir aussi floatingPointPrecision().

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

Fixe l'état du flux de données à l'adresse status.

Les appels ultérieurs à setStatus() sont ignorés jusqu'à ce que resetStatus() soit appelé.

Voir aussi Status, status(), et resetStatus().

void QDataStream::setVersion(int v)

Définit le numéro de version du format de sérialisation des données à v, une valeur de l'énumération Version.

Vous n'avez pas besoin de définir une version si vous utilisez la version actuelle de Qt, mais pour vos propres formats binaires personnalisés, nous vous recommandons de le faire ; voir Versioning dans la description détaillée.

Pour s'adapter aux nouvelles fonctionnalités, le format de sérialisation des flux de données de certaines classes Qt a changé dans certaines versions de Qt. Si vous souhaitez lire des données créées par une version antérieure de Qt, ou écrire des données qui peuvent être lues par un programme compilé avec une version antérieure de Qt, utilisez cette fonction pour modifier le format de sérialisation utilisé par QDataStream.

L'énumération Version fournit des constantes symboliques pour les différentes versions de Qt. Par exemple :

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

Voir aussi version() et Version.

qint64 QDataStream::skipRawData(qint64 len)

Sauter len octets de l'appareil. Renvoie le nombre d'octets effectivement ignorés, ou -1 en cas d'erreur.

Cela équivaut à appeler readRawData() sur un tampon de longueur len et à ignorer le tampon.

Voir aussi QIODevice::seek().

void QDataStream::startTransaction()

Démarre une nouvelle transaction de lecture sur le flux.

Définit un point de restauration dans la séquence des opérations de lecture. Pour les périphériques séquentiels, les données lues seront dupliquées en interne pour permettre la récupération en cas de lecture incomplète. Pour les périphériques à accès aléatoire, cette fonction enregistre la position actuelle du flux. Appelez commitTransaction(), rollbackTransaction() ou abortTransaction() pour terminer la transaction en cours.

Une fois qu'une transaction est lancée, les appels ultérieurs à cette fonction rendront la transaction récursive. Les transactions internes agissent en tant qu'agents de la transaction externe (c'est-à-dire qu'elles signalent l'état des opérations de lecture à la transaction externe, qui peut rétablir la position du flux).

Lorsqu'une erreur survient au cours d'une transaction (y compris l'échec d'une transaction interne), la lecture du flux de données est suspendue (toutes les opérations de lecture suivantes renvoient des valeurs vides ou nulles) et les transactions internes suivantes sont forcées d'échouer. Le démarrage d'une nouvelle transaction externe permet de sortir de cet état. Ce comportement rend inutile le contrôle d'erreur de chaque opération de lecture séparément.

Voir aussi commitTransaction(), rollbackTransaction() et abortTransaction().

QDataStream::Status QDataStream::status() const

Renvoie l'état du flux de données.

Voir aussi Status, setStatus(), et resetStatus().

int QDataStream::version() const

Renvoie le numéro de version du format de sérialisation des données.

Voir aussi setVersion() et Version.

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

Écrit le spécificateur de longueur len et le tampon s dans le flux et renvoie une référence au flux.

len est sérialisé sous la forme d'un quint32 et d'un quint64 optionnel, suivi de len octets provenant de s. Notez que les données ne sont pas encodées.

Voir aussi writeRawData() et readBytes().

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

Écrit len octets de s dans le flux. Renvoie le nombre d'octets effectivement écrits, ou -1 en cas d'erreur. Les données ne sont pas encodées.

Voir aussi writeBytes(), QIODevice::write(), et readRawData().

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

Retourne si ce flux n'a pas d'erreurs (status() retourne Ok).

Cette fonction a été introduite dans Qt 6.10.

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

Écrit un octet signé, i, dans le flux et renvoie une référence au flux.

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

Écrit une valeur booléenne, i, dans le flux. Renvoie une référence au flux.

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

Écrit un caractère, c, dans le flux. Renvoie une référence au flux

Cette fonction a été introduite dans Qt 6.0.

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

Écrit un caractère, c, dans le flux. Renvoie une référence au flux

Cette fonction a été introduite dans Qt 6.0.

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

Écrit la chaîne '\0'-terminée s dans le flux et renvoie une référence au flux.

La chaîne est sérialisée à l'aide de writeBytes().

Voir aussi writeBytes() et writeRawData().

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

Écrit un nombre à virgule flottante, f, dans le flux en utilisant le format standard IEEE 754. Renvoie une référence au flux.

Voir également setFloatingPointPrecision().

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

Écrit un nombre à virgule flottante, f, dans le flux en utilisant le format standard IEEE 754. Renvoie une référence au flux.

Voir également setFloatingPointPrecision().

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

Écrit un entier signé de 16 bits, i, dans le flux et renvoie une référence au flux.

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

Écrit un entier signé de 32 bits, i, dans le flux et renvoie une référence au flux.

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

Écrit un entier signé de 64 bits, i, dans le flux et renvoie une référence au flux.

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

Écrit un entier non signé de 16 bits, i, dans le flux et renvoie une référence au flux.

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

Écrit un entier non signé, i, dans le flux sous la forme d'un entier non signé de 32 bits (quint32). Renvoie une référence au flux.

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

Écrit un entier non signé de 64 bits, i, dans le flux et renvoie une référence au flux.

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

Écrit un octet non signé, i, dans le flux et renvoie une référence au flux.

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

Simule l'écriture d'un std::nullptr_t, ptr, dans le flux et renvoie une référence au flux. Cette fonction n'écrit en réalité rien dans le flux, car les valeurs std::nullptr_t sont stockées sous la forme de 0 octet.

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

Lit une valeur booléenne du flux dans i. Renvoie une référence au flux.

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

Lit un octet signé du flux dans i, et renvoie une référence au flux.

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

Lit la chaîne s à partir du flux et renvoie une référence au flux.

La chaîne est désérialisée à l'aide de readBytes() où le format de sérialisation est un spécificateur de longueur quint32 en premier, suivi du nombre d'octets de données. La chaîne résultante est toujours '\0'-terminée.

L'espace pour la chaîne est alloué à l'aide de new [] - l'appelant doit le détruire à l'aide de delete [].

Voir aussi readBytes() et readRawData().

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

Lit un caractère de 16 bits de large du flux dans c et renvoie une référence au flux.

Cette fonction a été introduite dans Qt 6.0.

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

Lit un caractère de 32 bits de large du flux dans c et renvoie une référence au flux.

Cette fonction a été introduite dans Qt 6.0.

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

Lit un nombre à virgule flottante du flux dans f, en utilisant le format standard IEEE 754. Renvoie une référence au flux.

Voir également setFloatingPointPrecision().

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

Lit un nombre à virgule flottante du flux dans f, en utilisant le format standard IEEE 754. Renvoie une référence au flux.

Voir également setFloatingPointPrecision().

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

Lit un entier signé de 16 bits du flux dans i, et renvoie une référence au flux.

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

Lit un entier signé de 32 bits du flux dans i, et renvoie une référence au flux.

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

Lit un entier signé de 64 bits du flux dans i, et renvoie une référence au flux.

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

Lit un entier 16 bits non signé du flux dans i, et renvoie une référence au flux.

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

Lit un entier 32 bits non signé du flux dans i, et renvoie une référence au flux.

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

Lit un entier 64 bits non signé dans le flux, dans i, et renvoie une référence au flux.

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

Lit un octet non signé du flux dans i, et renvoie une référence au flux.

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

Simule la lecture d'une valeur std::nullptr_t du flux dans ptr et renvoie une référence au flux. Cette fonction ne lit en réalité rien dans le flux, car les valeurs std::nullptr_t sont stockées sous la forme de 0 octet.