QCborStreamReader Class

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

QCborStreamReader::QCborStreamReader()

ソースデータのない QCborStreamReader オブジェクトを作成します。生成後、QCborStreamReader は解析エラーを報告します。

addData() を呼び出すか、setDevice() を使用して別のソースデバイスを設定することで、データを追加できます。

addData() およびisValid()も参照してください 。

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

device から読み込まれた CBOR ストリームを解析する QCborStreamReader オブジェクトを作成します。QCborStreamReader はdevice の所有権を取得しないため、このオブジェクトが破棄されるまで、 は有効な状態を維持する必要があります。

[explicit] QCborStreamReader::QCborStreamReader(const QByteArray &data)

data にある CBOR ストリームを解析する QCborStreamReader オブジェクトを作成します。

QCborStreamReader::QCborStreamReader(const char *data, qsizetype len)

data から始まるlen バイトのデータを持つ QCborStreamReader オブジェクトを作成します。このポインタは、QCborStreamReader が破棄されるまで有効なままである必要があります。

QCborStreamReader::QCborStreamReader(const quint8 *data, qsizetype len)

data から始まるlen バイトのデータを持つ QCborStreamReader オブジェクトを作成します。このポインタは、QCborStreamReader が破棄されるまで有効なままである必要があります。

[delete] QCborStreamReader::QCborStreamReader(const QCborStreamReader &)

QCborStreamReader のインスタンスをコピーして生成します。この関数は削除されています。

[noexcept] QCborStreamReader::~QCborStreamReader()

この `QCborStreamReader ` オブジェクトを破棄し、関連するリソースをすべて解放します。

void QCborStreamReader::addData(const QByteArray &data)

CBORストリームにdata を追加し、現在の要素を再解析します。この関数は、ストリームの処理中に以前にデータの末尾に到達していたものの、その後さらにデータが利用可能になった場合に役立ちます。

void QCborStreamReader::addData(const char *data, qsizetype len)

data から始まるlen バイトのデータを CBOR ストリームに追加し、現在の要素を再解析します。この関数は、ストリームの処理中にすでにデータの末尾に達していたものの、その後さらにデータが利用可能になった場合に役立ちます。

void QCborStreamReader::addData(const quint8 *data, qsizetype len)

data から始まるlen バイトのデータを CBOR ストリームに追加し、現在の要素を再解析します。この関数は、ストリームの処理中にデータの末尾に到達していたものの、その後さらにデータが入手可能になった場合に役立ちます。

void QCborStreamReader::clear()

デコーダの状態をクリアし、入力ソースデータを空のバイト配列にリセットします。この関数が呼び出された後、QCborStreamReader は解析エラーを示すようになります。

解析対象のデータを追加するには、addData() を呼び出してください。

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

int QCborStreamReader::containerDepth() const

このストリームが `enterContainer()` によって進入したが、まだ退出していないコンテナの数を返します。

enterContainer() およびleaveContainer()も参照してください 。

qint64 QCborStreamReader::currentOffset() const

現在デコード中の項目の入力ストリーム内のオフセットを返します。現在のオフセットが、これまでにデコードされたバイト数となるのは、ソースデータが `QByteArray ` である場合、またはデコード開始時に先頭に位置が設定されていた `QIODevice ` である場合に限られます。

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

qsizetype QCborStreamReader::currentStringChunkSize() const

現在のテキストまたはバイト文字列チャンクのサイズを返します。CBORストリームにチャンク化されていない文字列が含まれている場合（つまり、isLengthKnown() がtrue を返す場合）、この関数は文字列全体のサイズを返します。これはlength() と同じ動作です。

この関数は、後で `readStringChunk()` にポインタを渡すためのバッファを事前に割り当てる際に役立ちます。

readString()、readByteArray()、およびreadStringChunk()も参照してください 。

QIODevice *QCborStreamReader::device() const

setDevice() またはQCborStreamReader コンストラクタで設定された `QIODevice ` を返します。このオブジェクトが `QByteArray` から読み込んでいた場合、この関数は代わりに `nullptr` を返します。

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

bool QCborStreamReader::enterContainer()

現在の項目である配列またはマップに入り、そのコンテナに含まれる要素を反復処理する準備を行います。コンテナへの進入に成功した場合は true を返し、失敗した場合は false を返します（通常は解析エラー）。enterContainer() の各呼び出しには、leaveContainer() の呼び出しを必ず組み合わせる必要があります。

この関数は、現在の項目が配列またはマップである場合（つまり、isArray()、isMap()、またはisContainer()がtrueである場合）にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

leaveContainer()、isContainer()、isArray()、およびisMap()も参照してください 。

[noexcept] bool QCborStreamReader::hasNext() const

現在のコンテナ内にデコードすべき項目がまだ残っている場合は true を返し、末尾に達した場合は false を返します。ルート要素を解析している場合、hasNext() が false を返すと解析が完了したことを示します。それ以外の場合、コンテナの深さが 0 以外であれば、外側のコードでleaveContainer() を呼び出す必要があります。

parentContainerType()、containerDepth()、およびleaveContainer()も参照してください 。

bool QCborStreamReader::isArray() const

現在の要素の型が配列である場合（つまり、type() がQCborStreamReader::Array を返す場合）、true を返します。この関数が true を返す場合、enterContainer() を呼び出して、そのコンテナの解析を開始することができます。

現在の要素が配列である場合、isLengthKnown() を呼び出して、その配列のサイズが CBOR ストリーム内で明示的に指定されているかどうかを確認することもできます。明示的に指定されている場合、length() を呼び出すことでそのサイズを取得できます。

次の例では、より効率的なデコードを行うために、配列のサイズに基づいてQVariantList を事前に割り当てています：

QVariantList populateFromCbor(QCborStreamReader &reader)
{
    QVariantList list;
    if (reader.isLengthKnown())
        list.reserve(reader.length());

    reader.enterContainer();
    while (reader.lastError() == QCborError::NoError && reader.hasNext())
        list.append(readOneElement(reader));
    if (reader.lastError() == QCborError::NoError)
        reader.leaveContainer();

    return list;
}

type()、isMap()、isLengthKnown()、length()、enterContainer()、およびleaveContainer()も参照してください 。

bool QCborStreamReader::isBool() const

現在の要素がブール値（true またはfalse ）である場合は true を返し、それ以外の場合は false を返します。この関数が true を返した場合、toBool() を呼び出してブール値を取得できます。また、toSimpleType() を呼び出し、QCborSimpleValue::True または QCborSimpleValue::False と比較することもできます。

関連項目： type()、isFalse()、isTrue()、toBool()、isSimpleType()、およびtoSimpleType()。

bool QCborStreamReader::isByteArray() const

現在の要素の型がバイト配列である場合（つまり、type() がQCborStreamReader::ByteArray を返す場合）、true を返します。この関数が true を返す場合、readByteArray() を呼び出してそのデータを読み取ることができます。

type()、readByteArray()、およびisString()も参照してください 。

bool QCborStreamReader::isContainer() const

現在の要素がコンテナ（つまり、配列またはマップ）である場合は true を返し、それ以外の場合は false を返します。現在の要素がコンテナである場合、isLengthKnown() 関数を使用して、そのコンテナのサイズがストリーム内で明示されているかどうかを確認できます。明示されている場合は、length() を使用してそのサイズを取得できます。

さらに重要な点として、コンテナの場合、enterContainer() 関数を使用して、その中に含まれる要素の反復処理を開始することができます。

関連項目： type()、isArray()、isMap()、isLengthKnown()、length()、enterContainer()、leaveContainer()、およびcontainerDepth()。

bool QCborStreamReader::isDouble() const

現在の要素の型がIEEE 754倍精度浮動小数点型である場合（つまり、type()がQCborStreamReader::Double を返す場合）、trueを返します。この関数がtrueを返す場合、toDouble()を呼び出してそのデータを読み取ることができます。

type()、toDouble()、isFloat16()、およびisFloat()も参照してください 。

bool QCborStreamReader::isFalse() const

現在の要素がfalse の値である場合はtrueを返し、それ以外の場合はfalseを返します。

関連項目： type()、isTrue()、isBool()、toBool()、isSimpleType()、およびtoSimpleType()。

bool QCborStreamReader::isFloat16() const

現在の要素の型がIEEE 754半精度浮動小数点数である場合（つまり、type()がQCborStreamReader::Float16 を返す場合）、trueを返します。この関数がtrueを返した場合、toFloat16()を呼び出してそのデータを読み取ることができます。

type()、toFloat16()、isFloat()、およびisDouble()も参照してください 。

bool QCborStreamReader::isFloat() const

現在の要素の型がIEEE 754単精度浮動小数点型である場合（つまり、type()がQCborStreamReader::Float を返す場合）、trueを返します。この関数がtrueを返す場合、toFloat()を呼び出してそのデータを読み取ることができます。

type()、toFloat()、isFloat16()、およびisDouble()も参照してください 。

bool QCborStreamReader::isInteger() const

現在の要素の型が符号なし整数または負の整数である場合（つまり、type() がQCborStreamReader::UnsignedInteger またはQCborStreamReader::NegativeInteger を返す場合）、true を返します。この関数が true を返す場合、toInteger() を呼び出してその値を読み取ることができます。

関連項目： type()、toInteger()、toUnsignedInteger()、toNegativeInteger()、isUnsignedInteger()、およびisNegativeInteger()。

bool QCborStreamReader::isInvalid() const

現在の要素が無効な場合は true を返し、それ以外の場合は false を返します。デコードエラーが発生した場合、または配列やマップの最後の要素を解析した直後の場合、現在の要素は無効となる可能性があります。

関連項目： type() およびisValid()。

[noexcept] bool QCborStreamReader::isLengthKnown() const

現在の配列、マップ、バイト配列、または文字列の長さが判明している場合（CBORストリーム内で明示されている場合）、trueを返します。それ以外の場合はfalseを返します。この関数は、要素がこれらいずれかである場合にのみ呼び出す必要があります。

長さが判明している場合は、length() を呼び出すことで取得できます。

マップや配列の長さが不明な場合、その長さはストリーム内に存在する要素数によって暗黙的に決定されます。QCborStreamReader には、その状況で長さを計算するための API は用意されていません。

文字列やバイト配列も、長さが不定である場合があります（つまり、複数のチャンクに分けて送信される可能性があります）。これらは現在、QCborStreamWriter では作成できませんが、他のエンコーダでは作成できる可能性があるため、QCborStreamReader はそれらをサポートしています。

length()、QCborStreamWriter::startArray()、およびQCborStreamWriter::startMap()も参照してください 。

bool QCborStreamReader::isMap() const

現在の要素の型がマップである場合（つまり、type() がQCborStreamReader::Map を返す場合）、true を返します。この関数が true を返す場合、enterContainer() を呼び出して、そのコンテナの解析を開始することができます。

現在の要素がマップである場合、isLengthKnown() を呼び出して、そのマップのサイズが CBOR ストリーム内で明示されているかどうかを確認することもできます。明示されている場合、length() を呼び出すことでそのサイズを取得できます。

次の例では、より効率的なデコードを行うために、マップのサイズに基づいて `QVariantMap ` を事前に割り当てています：

QVariantMap populateFromCbor(QCborStreamReader &reader)
{
    QVariantMap map;
    if (reader.isLengthKnown())
        map = setMapLength(map, reader.length());

    reader.enterContainer();
    while (reader.lastError() == QCborError::NoError && reader.hasNext()) {
        QString key = readElementAsString(reader);
        map.insert(key, readOneElement(reader));
    }
    if (reader.lastError() == QCborError::NoError)
        reader.leaveContainer();

    return map;
}

上記の例では、readElementAsString という関数を使用してマップのキーを読み取り、文字列を取得しています。これは、CBOR マップのキーには文字列だけでなく、あらゆる型が含まれる可能性があるためです。 ユーザーコードでは、この変換を行うか、文字列以外のキーを拒否するか、あるいはQVariantMap やQVariantHash 以外のコンテナを使用する必要があります。例えば、マップに整数のキーが含まれることが予想される場合（ストリームのサイズと解析負荷を軽減できるため推奨されます）、適切なコンテナは\l{QMap}<int, QVariant> または\l{QHash}<int, QVariant> となります。

関連項目： type()、isArray()、isLengthKnown()、length()、enterContainer()、およびleaveContainer()。

bool QCborStreamReader::isNegativeInteger() const

現在の要素の型が負の整数である場合（つまり、type() がQCborStreamReader::NegativeInteger を返す場合）、true を返します。この関数が true を返す場合、toNegativeInteger() またはtoInteger() を呼び出してその値を読み取ることができます。

type()、toNegativeInteger()、toInteger()、isInteger()、およびisUnsignedInteger()も参照してください 。

bool QCborStreamReader::isNull() const

現在の要素がnull の値である場合はtrueを返し、それ以外の場合はfalseを返します。Null値は、一部のオプションデータの欠如を示すために使用されることがあります。

関連項目： type()、isSimpleType()、およびtoSimpleType()。

bool QCborStreamReader::isSimpleType() const

現在の要素の型が、ブール値（true および false）や null、undefined を含む任意の CBOR 単純型である場合に true を返します。これがどの単純型であるかを確認するには、toSimpleType() を呼び出します。あるいは、特定の単純型を検査するには、QCborSimpleType パラメータを取るオーバーロードを呼び出してください。

CBOR単純型とは、余分な値を持たない型のことです。255通りの可能性があります が、現在、定義された意味を持つ値は4つだけです。コードは未知の単純型に対処することを想定しておらず、未知の型が見つかった場合は、そのストリームを無効として単に破棄してもかまいません。

関連項目： QCborSimpleType 、type()、isSimpleType(QCborSimpleType)、およびtoSimpleType()。

bool QCborStreamReader::isSimpleType(QCborSimpleType st) const

現在の要素の型が単純型st である場合はtrueを返し、そうでない場合はfalseを返します。この関数がtrueを返した場合、toSimpleType()はst を返します。

CBORの単純型とは、余分な値を持たない型のことです。255通りの可能性があります が、現在、定義された意味を持つ値は4つしかありません。コードは未知の単純型に対処することを想定しておらず、未知の型が見つかった場合は、そのストリームを無効として破棄する可能性があります。

QCborSimpleType 、type()、isSimpleType()、およびtoSimpleType()も参照してください 。

bool QCborStreamReader::isString() const

現在の要素の型がテキスト文字列である場合（つまり、type() がQCborStreamReader::String を返す場合）、true を返します。この関数が true を返す場合、readString() を呼び出してそのデータを読み取ることができます。

type()、readString()、およびisByteArray()も参照してください 。

bool QCborStreamReader::isTag() const

現在の要素の型がCBORタグである場合（つまり、type()がQCborStreamReader::Tag を返す場合）、trueを返します。この関数がtrueを返す場合、toTag()を呼び出してそのデータを読み取ることができます。

type() およびtoTag()も参照してください 。

bool QCborStreamReader::isTrue() const

現在の要素がtrue の値である場合はtrueを返し、それ以外の場合はfalseを返します。

関連項目： type()、isFalse()、isBool()、toBool()、isSimpleType()、toSimpleType()も参照してください 。

bool QCborStreamReader::isUndefined() const

現在の要素がundefined の値である場合はtrueを返し、それ以外の場合はfalseを返します。未定義の値は、ストリームの作成時に何らかの変換が失敗したか、または変換が不可能であったことを示すためにエンコードされている場合があります。QCborStreamReader は決して置換を行わないため、この関数はストリームに明示的な未定義の値が含まれている場合にのみtrueを返します。

type()、isSimpleType()、およびtoSimpleType()も参照してください 。

bool QCborStreamReader::isUnsignedInteger() const

現在の要素の型が符号なし整数である場合（つまり、type() がQCborStreamReader::UnsignedInteger を返す場合）、true を返します。この関数が true を返す場合、toUnsignedInteger() またはtoInteger() を呼び出してその値を読み取ることができます。

type()、toUnsignedInteger()、toInteger()、isInteger()、およびisNegativeInteger()も参照してください 。

bool QCborStreamReader::isValid() const

現在の要素が有効な場合は true を返し、そうでない場合は false を返します。デコードエラーが発生した場合、または配列やマップの最後の要素を解析した直後の場合、現在の要素は無効となる可能性があります。

関連項目： type() およびisInvalid()。

QCborError QCborStreamReader::lastError() const

ストリームのデコード中に発生した最後のエラー（ある場合）を返します。エラーが発生しなかった場合は、QCborError::NoError を返します。

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

bool QCborStreamReader::leaveContainer()

処理中の配列またはマップを離れ、コンテナの末尾の次の要素にデコーダーの位置を移動させます。コンテナからの離脱に成功した場合は true を返し、失敗した場合は false を返します（通常は解析エラー）。enterContainer() の各呼び出しには、必ず leaveContainer() の呼び出しを組み合わせる必要があります。

この関数は、hasNext()がfalseを返し、かつcontainerDepth()が0でない場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

enterContainer()、parentContainerType()、およびcontainerDepth()も参照してください 。

quint64 QCborStreamReader::length() const

文字列またはバイト配列の長さ、あるいは配列内の要素数、またはマップ内の要素ペアの数を、それが判明している場合に返します。長さが不明な場合（つまり、isLengthKnown() が false を返した場合）、この関数を呼び出してはなりません。 そうするとエラーとなり、QCborStreamReader が入力ストリームの解析を停止します。

isLengthKnown()、QCborStreamWriter::startArray()、およびQCborStreamWriter::startMap()も参照してください 。

bool QCborStreamReader::next(int maxRecursion = 10000)

CBORストリームのデコードを1要素分進めます。通常、この関数は固定幅の基本要素（つまり、整数、単純値、タグ、浮動小数点値）を解析する際に呼び出す必要があります。ただし、現在の項目が文字列、配列、またはマップである場合にもこの関数を呼び出すことができ、その場合、含まれるすべての要素を含め、その要素全体をスキップします。

この関数は、進め処理が成功した場合は true を返し、そうでない場合は false を返します。ストリームが破損している、不完全である、または配列やマップのネストレベルがmaxRecursion を超える場合、失敗する可能性があります。また、hasNext() が false を返した状態でこの関数を呼び出すこともエラーとなります。この関数が false を返した場合、lastError() は、失敗の原因を詳細に示すエラーコードを返します。

lastError()、isValid()、およびhasNext()も参照してください 。

QCborStreamReader::Type QCborStreamReader::parentContainerType() const

QCborStreamReader::Array またはQCborStreamReader::Map のいずれかを返します。これは、現在の項目を含むコンテナがそれぞれ配列かマップかを示します。現在ルート要素を解析中の場合、この関数はQCborStreamReader::Invalid を返します。

containerDepth() およびenterContainer()も参照してください 。

[since 6.7] QByteArray QCborStreamReader::readAllByteArray()

現在のバイト文字列をデコードして、それを返します。文字列がチャンク化されている場合、この関数はすべてのチャンクを順に処理し、それらを連結します。 エラーが発生した場合、この関数はデフォルト構築された QByteArray() を返しますが、特定の空のバイト文字列と区別がつかない場合があります。代わりに、lastError() を確認して、エラーが発生したかどうかを判断してください。

この関数は、整数や文字列からの変換を含め、いかなる型変換も行いません。したがって、isByteArray() が true の場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

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

readByteArray()、readStringChunk()、isByteArray()、およびreadAllString()も参照してください 。

[since 6.7] QString QCborStreamReader::readAllString()

現在のテキスト文字列をデコードして返します。文字列がチャンク化されている場合、この関数はすべてのチャンクを順に処理し、それらを連結します。エラーが発生した場合、この関数はデフォルト構築された QString() を返しますが、特定の空のテキスト文字列と区別がつかない場合があります。代わりに、lastError() を確認して、エラーが発生したかどうかを判断してください。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString() が true を返した場合にのみ呼び出すことができます。それ以外の状況で呼び出すことはエラーとなります。

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

readString()、readStringChunk()、isString()、およびreadAllByteArray()も参照してください 。

[since 6.7] QByteArray QCborStreamReader::readAllUtf8String()

現在のテキスト文字列をデコードして返します。文字列がチャンク分割されている場合、この関数はすべてのチャンクを順に処理して連結します。エラーが発生した場合、この関数はデフォルト構築された QString() を返しますが、特定の空のテキスト文字列と区別がつかない場合があります。そのため、エラーが発生したかどうかを確認するには、lastError() をチェックしてください。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString() が true を返した場合にのみ呼び出すことができます。それ以外の状況で呼び出すことはエラーとなります。

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

readString()、readStringChunk()、isString()、およびreadAllByteArray()も参照してください 。

[since 6.7] bool QCborStreamReader::readAndAppendToByteArray(QByteArray &dst)

現在のバイト文字列をデコードし、dst に追加します。文字列がチャンク化されている場合、この関数はすべてのチャンクを順に処理して連結します。デコード中にエラーが発生した場合でも、正常にデコードできた他のチャンクがdst に書き込まれている可能性があります。デコードがエラーなしで完了した場合はtrue を返し、それ以外の場合はfalse を返します。

この関数は、整数や文字列からの変換を含め、いかなる型変換も行いません。したがって、isByteArray() が true の場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

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

readByteArray()、readStringChunk()、isByteArray()、およびreadAndAppendToString()も参照してください 。

[since 6.7] bool QCborStreamReader::readAndAppendToString(QString &dst)

現在のテキスト文字列をデコードし、dst に追加します。文字列がチャンク化されている場合、この関数はすべてのチャンクを順に処理して連結します。デコード中にエラーが発生した場合でも、正常にデコードできた他のチャンクがdst に書き込まれている可能性があります。デコードがエラーなく完了した場合はtrue を返し、それ以外の場合はfalse を返します。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString() が true を返した場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

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

readString()、readStringChunk()、isString()、およびreadAndAppendToByteArray()も参照してください 。

[since 6.7] bool QCborStreamReader::readAndAppendToUtf8String(QByteArray &dst)

現在のテキスト文字列をデコードし、dst に追加します。文字列がチャンク化されている場合、この関数はすべてのチャンクを順に処理して連結します。デコード中にエラーが発生した場合でも、正常にデコードできた他のチャンクがdst に書き込まれている可能性があります。デコードがエラーなく完了した場合はtrue を返し、それ以外の場合はfalse を返します。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString() が true を返した場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

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

readString()、readStringChunk()、isString()、およびreadAndAppendToByteArray()も参照してください 。

QCborStreamReader::StringResult<QByteArray> QCborStreamReader::readByteArray()

CBOR文字列から1バイトの配列チャンクをデコードして返します。この関数は通常のコンテンツとチャンク化されたコンテンツの両方に使用されるため、呼び出し元は、isLengthKnown()がtrueの場合であっても、常にループを回してこの関数を呼び出す必要があります。この関数の一般的な使用例は以下の通りです：

QByteArray decodeBytearray(QCborStreamReader &reader)
{
    QByteArray result;
    auto r = reader.readByteArray();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readByteArray();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

readAllByteArray() 関数は、上記のループといくつかの追加チェックを実装しています。

この関数は、整数や文字列からの変換を含め、いかなる型変換も行いません。したがって、isByteArray()がtrueの場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

readAllByteArray()、readString()、isByteArray()、およびreadStringChunk()も参照してください 。

QCborStreamReader::StringResult<QString> QCborStreamReader::readString()

CBOR文字列から1つの文字列チャンクをデコードして返します。この関数は、通常の文字列コンテンツとチャンク化された文字列コンテンツの両方に使用されるため、呼び出し元は、isLengthKnown() が true の場合でも、常にループを回してこの関数を呼び出す必要があります。この関数の一般的な使用例は以下の通りです：

QString decodeString(QCborStreamReader &reader)
{
    QString result;
    auto r = reader.readString();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readString();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

readAllString() 関数は、上記のループといくつかの追加チェックを実装しています。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString()がtrueを返した場合にのみ呼び出すことができ、それ以外の状況で呼び出すとエラーとなります。

readAllString()、readByteArray()、isString()、およびreadStringChunk()も参照してください 。

QCborStreamReader::StringResult<qsizetype> QCborStreamReader::readStringChunk(char *ptr, qsizetype maxlen)

現在の文字列チャンクを、ptr が指すバッファ（サイズはmaxlen ）に読み込みます。この関数はStringResult オブジェクトを返し、ptr にコピーされたバイト数は\l のStringResult::data メンバーに格納されます。\l のStringResult::status メンバーは、文字列の読み取り中にエラーが発生したか、データがコピーされたか、あるいはこれが最後のチャンクであったかを示します。

この関数は、String 型とByteArray 型の両方で呼び出すことができます。後者の場合、この関数はreadByteArray()が返したであろうのと同じデータを読み取ります。文字列の場合、この関数は、QString が返したであろう値のUTF-8相当値を返します。

この関数は通常、ループ内でcurrentStringChunkSize() と組み合わせて使用されます。例：

QCborStreamReader::StringResult<qsizetype> result;
do {
    qsizetype size = reader.currentStringChunkSize();
    qsizetype oldsize = buffer.size();
    buffer.resize(oldsize + size);
    result = reader.readStringChunk(buffer.data() + oldsize, size);
} while (result.status == QCborStreamReader::Ok);

readByteArray() やreadString() とは異なり、この関数はQByteArray およびQString の実装上の制限を受けません。

currentStringChunkSize()、readString()、readByteArray()、isString()、およびisByteArray()も参照してください 。

[since 6.7] QCborStreamReader::StringResult<QByteArray> QCborStreamReader::readUtf8String()

CBOR文字列から1つの文字列チャンクをデコードして返します。この関数は、通常の文字列コンテンツとチャンク化された文字列コンテンツの両方に使用されるため、呼び出し元は、isLengthKnown()がtrueの場合であっても、常にこの関数をループ処理して呼び出す必要があります。この関数の典型的な使用法は、以下のreadString()と同様です。

QString decodeString(QCborStreamReader &reader)
{
    QString result;
    auto r = reader.readString();
    while (r.status == QCborStreamReader::Ok) {
        result += r.data;
        r = reader.readString();
    }

    if (r.status == QCborStreamReader::Error) {
        // handle error condition
        result.clear();
    }
    return result;
}

readAllUtf8String() 関数は、上記のループと、いくつかの追加のチェックを実装しています。

この関数は、整数やバイト配列からの変換を含め、いかなる型変換も行いません。したがって、isString() が true を返した場合にのみ呼び出すことができ、それ以外の状況で呼び出すとエラーとなります。

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

readAllString()、readByteArray()、isString()、およびreadStringChunk()も参照してください 。

void QCborStreamReader::reparse()

現在の要素を再解析します。この関数は、CBORストリームの末尾に達する前に入力データの末尾に到達したために解析が失敗した後、ソースのQIODevice に新たなデータが利用可能になった際に呼び出す必要があります。

QByteArray() から読み込む際、addData() 関数は自動的にこの関数を呼び出します。読み取りが失敗していない状態でこの関数を呼び出しても、何もしません。

void QCborStreamReader::reset()

ソースを先頭に戻し、デコーダの状態をクリアします。ソースデータがQByteArray だった場合、QCborStreamReader は配列の先頭から再起動します。

ソースデータがQIODevice の場合、この関数はQIODevice::reset()を呼び出し、バイト位置0にシークします。デバイスの先頭（例：ファイルの先頭）にCBORストリームが見つからない場合、この関数は意図しない動作をする可能性があります。その代わりに、QIODevice を適切なオフセット位置に設定し、setDevice()を呼び出してください。

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

void QCborStreamReader::setDevice(QIODevice *device)

データのソースを `device` に設定し、デコーダを初期状態にリセットします。

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

bool QCborStreamReader::toBool() const

現在の要素のブール値を返します。

この関数は、整数からの変換を含め、いかなる型変換も行いません。したがって、isTrue()、isFalse()、またはisBool()がtrueを返した場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

isBool()、isTrue()、isFalse()、およびtoInteger()も参照してください 。

double QCborStreamReader::toDouble() const

現在の要素の 64 ビット倍精度浮動小数点値を返します。

この関数は、他の浮動小数点型や整数値からの変換を含め、いかなる型変換も行いません。したがって、isDouble() が真の場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

isDouble()、toFloat16()、およびtoFloat()も参照してください 。

qfloat16 QCborStreamReader::toFloat16() const

現在の要素の 16 ビット半精度浮動小数点値を返します。

この関数は、他の浮動小数点型や整数値からの変換を含め、いかなる型変換も行いません。したがって、isFloat16()が真の場合にのみ呼び出すことができます。それ以外の条件で呼び出すとエラーとなります。

isFloat16()、toFloat()、およびtoDouble()も参照してください 。

float QCborStreamReader::toFloat() const

現在の要素の 32 ビット単精度浮動小数点値を返します。

この関数は、他の浮動小数点型や整数値からの変換を含め、いかなる型変換も行いません。したがって、isFloat() が真の場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

isFloat()、toFloat16()、およびtoDouble()も参照してください 。

qint64 QCborStreamReader::toInteger() const

現在の要素の整数値を、負、正、ゼロを問わず返します。値が²⁶³- 1 より大きい、または^-263 より小さい場合、返される値はオーバーフローし、符号が不正になります。これらの値を扱う必要がある場合は、代わりに `toUnsignedInteger()` または `toNegativeInteger()` を使用してください。

この関数は、ブール値やCBORタグからの変換を含め、いかなる型変換も行いません。したがって、isInteger()がtrueの場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

isInteger()、toUnsignedInteger()、およびtoNegativeInteger()も参照してください 。

QCborNegativeInteger QCborStreamReader::toNegativeInteger() const

現在の要素の負の整数値を返します。QCborNegativeValue は、CBOR ストリームに格納されていた負の数の絶対値を含む 64 ビットの符号なし整数です。なお、QCborNegativeValue(0) は^-264 を表します。

この関数は、ブール値やCBORタグからの変換を含め、いかなる型変換も行いません。したがって、isNegativeInteger()がtrueの場合にのみ呼び出すことができます。それ以外の条件下で呼び出すとエラーとなります。

この関数は、toInteger()の戻り値型の範囲を超える数値を取得するために使用できます。ただし、^-263より小さい負の数の使用は、極力避けるべきです。

関連項目： type()、toInteger()、isNegativeInteger()、およびisUnsignedInteger()。

QCborSimpleType QCborStreamReader::toSimpleType() const

現在の単純型の値を返します。

この関数は、整数からの変換を含め、いかなる型変換も行いません。したがって、isSimpleType() が真の場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

関連項目： isSimpleType()、isTrue()、isFalse()、isBool()、isNull()、およびisUndefined()。

QCborTag QCborStreamReader::toTag() const

現在の要素のタグ値を返します。

この関数は、整数からの変換を含め、いかなる型変換も行いません。したがって、isTag() が true の場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

タグとは、汎用 CBOR 型に付加され、それらにさらなる意味を与える 64 ビットの数値です。既知のタグの一覧については、QCborKnownTags 列挙型を参照してください。

isTag()、toInteger()、およびQCborKnownTagsも参照してください 。

quint64 QCborStreamReader::toUnsignedInteger() const

現在の要素の符号なし整数値を返します。

この関数は、ブール値やCBORタグからの変換を含め、いかなる型変換も行いません。したがって、isUnsignedInteger()がtrueの場合にのみ呼び出すことができます。それ以外の状況で呼び出すとエラーとなります。

この関数は、toInteger() の戻り値の型が扱う範囲を超える数値を取得するために使用できます。

type()、toInteger()、isUnsignedInteger()、およびisNegativeInteger()も参照してください 。

QCborStreamReader::Type QCborStreamReader::type() const

現在の要素の型を返します。返り値は、有効な型のいずれか、または「Invalid」となります。

関連項目： isValid()、isUnsignedInteger()、isNegativeInteger()、isInteger()、isByteArray()、isString()、isArray()、isMap()、isTag()、isSimpleType()、isBool()、isFalse()、isTrue()、isNull()、isUndefined()、isFloat16()、isFloat()、およびisDouble()。

[delete] QCborStreamReader &QCborStreamReader::operator=(const QCborStreamReader &)

other をこのQCborStreamReader インスタンスにコピーして代入します。この関数は削除されます。