QDataStream Class

メンバ関数のドキュメント

QDataStream::QDataStream()

I/O デバイスを持たないデータストリームを構築します。

setDevice()も参照してください 。

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

I/O デバイス `d` を使用するデータストリームを構築します。

setDevice() およびdevice()も参照してください 。

QDataStream::QDataStream(const QByteArray &a)

バイト配列 `a` を操作する読み取り専用のデータストリームを構築します。バイト配列への書き込みを行う場合は、`QDataStream(QByteArray*, int)` を使用してください。

QByteArray はQIODevice のサブクラスではないため、内部的にはバイト配列をラップするためにQBuffer が作成されます。

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

バイト配列（a ）を操作するデータストリームを構築します。mode は、このデバイスの使用方法を記述したものです。

あるいは、バイト配列から読み取るだけの場合には、QDataStream(constQByteArray &) を使用することもできます。

QByteArray はQIODevice のサブクラスではないため、内部的にはバイト配列をラップするQBuffer が作成されます。

[noexcept] QDataStream::~QDataStream()

データストリームを破棄します。

デストラクタは、現在のI/Oデバイスには影響を与えません。ただし、コンストラクタで渡されたQByteArray を処理している内部I/Oデバイス（例：QBuffer ）である場合は例外であり、その場合は内部I/Oデバイスが破棄されます。

void QDataStream::abortTransaction()

読み取りトランザクションを中止します。

この関数は、上位プロトコルのエラーやストリームの同期が失われた後に、トランザクションを破棄するために一般的に使用されます。

内部トランザクションに対して呼び出された場合、中止処理は最外部のトランザクションに委譲され、その後開始された内部トランザクションは強制的に失敗となります。

最外部のトランザクションについては、復元ポイントおよびストリームの内部で複製されたデータを破棄します。ストリームの現在の読み取り位置には影響しません。

データストリームのステータスを

startTransaction()、commitTransaction()、およびrollbackTransaction()も参照してください 。

bool QDataStream::atEnd() const

I/O デバイスが末尾（ストリームまたはファイルの末尾）に達した場合、または I/O デバイスが設定されていない場合は、true を返します。それ以外の場合は、false を返します。

QIODevice::atEnd()も参照してください 。

QDataStream::ByteOrder QDataStream::byteOrder() const

現在のバイト順の設定（BigEndian またはLittleEndian ）を返します。

setByteOrder()も参照してください 。

bool QDataStream::commitTransaction()

読み取りトランザクションを完了します。トランザクション中に読み取りエラーが発生しなかった場合はtrue を返し、そうでない場合はfalse を返します。

内部トランザクション内で呼び出された場合、コミットは、最外側の commitTransaction()、rollbackTransaction()、またはabortTransaction() の呼び出しが行われるまで延期されます。

それ以外の場合、ストリームのステータスがデータの末尾を超えて読み込まれたことを示している場合、この関数はストリームデータをstartTransaction() が呼び出された時点の状態に復元します。 この状況が発生した場合は、さらにデータが到着するのを待ってから、新しいトランザクションを開始する必要があります。データストリームが破損したデータを読み込んだ場合、または内部のトランザクションのいずれかが中止された場合、この関数はトランザクションを中止します。

startTransaction()、rollbackTransaction()、およびabortTransaction()も参照してください 。

QIODevice *QDataStream::device() const

現在設定されているI/Oデバイスを返します。デバイスが設定されていない場合は、nullptr を返します。

setDevice()も参照してください 。

QDataStream::FloatingPointPrecision QDataStream::floatingPointPrecision() const

データストリームの浮動小数点精度を返します。

FloatingPointPrecision およびsetFloatingPointPrecision()も参照してください 。

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

ストリームからバッファ `s ` を読み取り、そのストリームへの参照を返します。

バッファ `s ` は、new [] を使用して割り当てられます。`delete [] ` 演算子を使用して破棄してください。

l パラメータは、バッファの長さに設定されます。読み込まれた文字列が空の場合、l は 0 に、s はnullptr に設定されます。

シリアライズ形式は、最初に長さ指定子があり、その後にl バイトのデータが続きます。 バージョンが 6.7 未満の場合、または要素数が 0xfffffffe (2^32 - 2) 未満の場合は、長さ指定子は 1 つの quint32 です。それ以外の場合は、拡張値 0xfffffffe の後に、実際の値を含む 1 つの quint64 が続きます。 さらに、isNull() をサポートするコンテナの場合、すべてのビットがセットされ、データが含まれない単一の quint32 としてエンコードされます。

この関数は Qt 6.7 で導入されました。

readRawData() およびwriteBytes()も参照してください 。

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

ストリームから最大len バイトをs に読み込み、読み込んだバイト数を返します。エラーが発生した場合、この関数は-1を返します。

バッファ `s ` は事前に割り当てておく必要があります。データはデコードされません。

readBytes()、QIODevice::read()、およびwriteRawData()も参照してください 。

void QDataStream::resetStatus()

データストリームの状態をリセットします。

Status 、status()、およびsetStatus()も参照してください 。

void QDataStream::rollbackTransaction()

読み取りトランザクションをロールバックします。

この関数は、トランザクションのコミット前に不完全な読み取りが検出された場合に、トランザクションをロールバックするためによく使用されます。

内部トランザクションで呼び出された場合、ロールバックは最外部のトランザクションに委譲され、その後開始された内部トランザクションは強制的に失敗となります。

最外側のトランザクションについては、データストリームをstartTransaction()の呼び出し時点の状態に復元します。データストリームが破損したデータを読み込んだ場合、または内部トランザクションのいずれかが中止された場合、この関数はトランザクションを中止します。

先行するストリーム操作が成功した場合は、データストリームのステータスを

startTransaction()、commitTransaction()、およびabortTransaction()も参照してください 。

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

シリアライゼーションのバイト順を「bo 」に設定します。

bo パラメータには、QDataStream::BigEndian またはQDataStream::LittleEndian を指定できます。

デフォルト設定はビッグエンディアンです。特別な要件がない限り、この設定のままにしておくことをお勧めします。

byteOrder()も参照してください 。

void QDataStream::setDevice(QIODevice *d)

void QDataStream::setDevice(QIODevice *d)

I/O デバイスを `d` に設定します。引数として `nullptr ` を指定すると、現在の I/O デバイスの設定を解除できます。

device()も参照してください 。

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

データストリームの浮動小数点精度をprecision に設定します。浮動小数点精度がDoublePrecision で、データストリームのバージョンがQt_4_6 以上の場合、すべての浮動小数点数は64ビット精度で読み書きされます。 浮動小数点精度がSinglePrecision で、バージョンがQt_4_6 以上の場合、すべての浮動小数点数は 32 ビット精度で書き込まれ、読み込まれます。

Qt_4_6 より前のバージョンでは、データストリーム内の浮動小数点数の精度は、呼び出されたストリーム演算子によって異なります。

デフォルトはDoublePrecision です。

このプロパティは、qfloat16 インスタンスのシリアル化やデシリアル化には影響しないことに注意してください。

floatingPointPrecision()も参照してください 。

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

データストリームのステータスを、指定されたstatus に設定します。

resetStatus() が呼び出されるまで、その後の setStatus() への呼び出しは無視されます。

Status 、status()、およびresetStatus()も参照してください 。

void QDataStream::setVersion(int v)

データシリアライゼーション形式のバージョン番号を、Version 列挙型の値であるv に設定します。

Qt の最新バージョンを使用している場合は、バージョンを設定する必要はありませんが、独自のバイナリ形式を使用する場合は、設定することをお勧めします。詳細については、「詳細な説明」の「Versioning 」を参照してください。

新機能に対応するため、一部の Qt クラスのデータストリームシリアライゼーション形式は、Qt のバージョンによって変更されています。 以前のバージョンの Qt で作成されたデータを読み込む場合、または以前のバージョンの Qt でコンパイルされたプログラムで読み込めるデータを書き込む場合は、この関数を使用してQDataStream が使用するシリアライズ形式を変更してください。

Version 列挙型は、Qt の各バージョンに対応するシンボリック定数を提供します。例：

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

version() およびVersionも参照してください 。

qint64 QDataStream::skipRawData(qint64 len)

デバイスからlen バイトをスキップします。実際にスキップされたバイト数を返します。エラーが発生した場合は-1を返します。

これは、長さlen のバッファに対してreadRawData() を呼び出し、そのバッファを無視することと同等です。

QIODevice::seek()も参照してください 。

void QDataStream::startTransaction()

ストリーム上で新しい読み取りトランザクションを開始します。

読み取り操作のシーケンス内で復元可能なポイントを定義します。シーケンシャルデバイスでは、読み取りが不完全だった場合の回復を可能にするため、読み取りデータが内部で複製されます。ランダムアクセスデバイスでは、この関数はストリームの現在の位置を保存します。現在のトランザクションを終了するには、commitTransaction()、rollbackTransaction()、またはabortTransaction() を呼び出してください。

トランザクションが開始されると、この関数をその後呼び出すたびに、トランザクションは再帰的になります。内部のトランザクションは、最外側のトランザクションの代理として機能します（つまり、読み取り操作のステータスを最外側のトランザクションに報告し、最外側のトランザクションがストリームの位置を復元できるようにします）。

トランザクション中にエラーが発生した場合（内部トランザクションの失敗を含む）、データストリームからの読み取りは一時停止され（その後のすべての読み取り操作は空またはゼロの値を返す）、後続の内部トランザクションは強制的に失敗となります。新しい最外部トランザクションを開始することで、この状態から回復します。この挙動により、読み取り操作ごとに個別にエラーチェックを行う必要がなくなります。

関連項目： commitTransaction()、rollbackTransaction()、abortTransaction()。

QDataStream::Status QDataStream::status() const

データストリームのステータスを返します。

Status 、setStatus()、およびresetStatus()も参照してください 。

int QDataStream::version() const

データシリアライゼーション形式のバージョン番号を返します。

setVersion() およびVersionも参照してください 。

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

長さ指定子 `len ` とバッファ `s ` をストリームに書き込み、そのストリームへの参照を返します。

len は quint32 およびオプションの quint64 としてシリアル化され、その後にs からのlen バイトが続きます。データはエンコードされていないことに注意してください。

writeRawData() およびreadBytes()も参照してください 。

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

s からlen バイトをストリームに書き込みます。実際に書き込まれたバイト数を返します。エラーが発生した場合は -1 を返します。データはエンコードされません。

writeBytes()、QIODevice::write()、およびreadRawData()も参照してください 。

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

このストリームにエラーがないかどうかを返します（status() はOk を返します）。

この関数は Qt 6.10 で導入されました。

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

符号付きバイト（i ）をストリームに書き込み、そのストリームへの参照を返します。

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

ブール値（i ）をストリームに書き込みます。ストリームへの参照を返します。

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

文字「c 」をストリームに書き込みます。ストリームへの参照を返します

この関数は Qt 6.0 で導入されました。

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

文字「c 」をストリームに書き込みます。ストリームへの参照を返します

この関数は Qt 6.0 で導入されました。

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

「\0 」で終了する文字列 `s ` をストリームに書き込み、そのストリームへの参照を返します。

文字列は `writeBytes()` を使用してシリアライズされます。

writeBytes() およびwriteRawData()も参照してください 。

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

浮動小数点数 `f` を、標準のIEEE 754形式を使用してストリームに書き込みます。ストリームへの参照を返します。

setFloatingPointPrecision()も参照してください 。

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

浮動小数点数 `f` を、標準のIEEE 754形式を使用してストリームに書き込みます。ストリームへの参照を返します。

setFloatingPointPrecision()も参照してください 。

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

符号付き16ビット整数（i ）をストリームに書き込み、そのストリームへの参照を返します。

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

符号付き32ビット整数i をストリームに書き込み、そのストリームへの参照を返します。

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

符号付き64ビット整数i をストリームに書き込み、そのストリームへの参照を返します。

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

i の値を持つ符号なし 16 ビット整数をストリームに書き込み、そのストリームへの参照を返します。

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

i の値を持つ符号なし整数を、32 ビットの符号なし整数（quint32）としてストリームに書き込みます。ストリームへの参照を返します。

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

i の符号なし64ビット整数をストリームに書き込み、そのストリームへの参照を返します。

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

i の値を持つ符号なしバイトをストリームに書き込み、そのストリームへの参照を返します。

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

std::nullptr_t 、ptr をストリームに書き込むことをシミュレートし、そのストリームへの参照を返します。std::nullptr_t の値は0バイトとして格納されるため、この関数は実際にはストリームに何も書き込みません。

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

ストリームからブール値を読み取り、i に格納します。ストリームへの参照を返します。

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

ストリームから符号付きバイトをi に読み込み、ストリームへの参照を返します。

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

ストリームから文字列 `s ` を読み取り、そのストリームへの参照を返します。

文字列は `readBytes() ` を使用して逆シリアル化されます。シリアル化形式は、最初に `quint32 ` 長さの指定子があり、その後に指定されたバイト数のデータが続く形式です。結果として得られる文字列は、常に `'\0'` で終了します。

文字列用のメモリ領域はnew [] を使用して割り当てられます。呼び出し元はdelete [] を使用してこれを破棄する必要があります。

readBytes() およびreadRawData()も参照してください 。

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

ストリームから16ビット幅のchar型データをc に読み込み、ストリームへの参照を返します。

この関数は Qt 6.0 で導入されました。

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

ストリームから32ビット幅の文字を読み取り、c に格納し、ストリームへの参照を返します。

この関数は Qt 6.0 で導入されました。

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

標準のIEEE 754形式を使用して、ストリームから浮動小数点数をf に読み込みます。ストリームへの参照を返します。

setFloatingPointPrecision()も参照してください 。

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

標準のIEEE 754形式を使用して、ストリームから浮動小数点数をf に読み込みます。ストリームへの参照を返します。

setFloatingPointPrecision()も参照してください 。

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

ストリームから符号付き16ビット整数をi に読み込み、ストリームへの参照を返します。

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

ストリームから符号付き32ビット整数をi に読み込み、ストリームへの参照を返します。

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

ストリームから符号付き64ビット整数をi に読み込み、ストリームへの参照を返します。

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

ストリームから符号なし16ビット整数をi に読み込み、ストリームへの参照を返します。

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

ストリームから符号なし32ビット整数を読み取り、i に格納し、ストリームへの参照を返します。

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

ストリームから符号なし64ビット整数をi に読み込み、ストリームへの参照を返します。

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

ストリームから符号なしバイトをi に読み込み、ストリームへの参照を返します。

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

ストリームからstd::nullptr_t をptr に読み込むことをシミュレートし、ストリームへの参照を返します。std::nullptr_t の値は0バイトとして格納されるため、この関数は実際にはストリームから何も読み込みません。