JsonSerializer.DeserializeAsync メソッド

定義

名前空間:

System.Text.Json

アセンブリ:

System.Text.Json.dll

オーバーロード

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)	1 つの JSON 値を表す UTF-8 でエンコードされたテキストを に returnType読み取ります。 Stream は完了まで読み取られます。
DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)
DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)	単一の JSON 値を表す UTF-8 エンコード テキストを、指定された型のインスタンスに、非同期に読み取ります。 ストリームは最後まで読み取られます。
DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken)	1 つの JSON 値を表す UTF-8 でエンコードされたテキストを に TValue読み取ります。 Stream は完了まで読み取られます。
DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)	単一の JSON 値を表す UTF-8 エンコード テキストを、ジェネリック型パラメーターで指定された型のインスタンスに、非同期に読み取ります。 ストリームは最後まで読み取られます。

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

1 つの JSON 値を表す UTF-8 でエンコードされたテキストを に returnType読み取ります。 Stream は完了まで読み取られます。

public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.Serialization.JsonSerializerContext context, System.Threading.CancellationToken cancellationToken = default);

static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.Serialization.JsonSerializerContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>

Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)

パラメーター

utf8Json

Stream

解析する JSON データ。

returnType

Type

変換元または変換先のオブジェクトの型。

context

JsonSerializerContext

シリアル化可能な型のメタデータ プロバイダー。

cancellationToken

CancellationToken

CancellationToken読み取り操作を取り消すために使用できる 。

戻り値

ValueTask<Object>

JSON 値の returnType 表現。

例外

ArgumentNullException

utf8Json、returnType、または context が null です。

JsonException

JSON が無効であるか、 returnType が JSON と互換性がないか、Stream に残りのデータがあります。

NotSupportedException

returnType またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。

InvalidOperationException

指定された context の メソッドはGetTypeInfo(Type)、 と互換性のある JsonTypeInforeturnTypeを返しませんでした。

注釈

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Deserialize(Stream, Type, JsonSerializerContext)スローされる例外に関するページを参照してください。

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);

static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>

Public Function DeserializeAsync (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)

パラメーター

utf8Json

Stream

jsonTypeInfo

JsonTypeInfo

cancellationToken

CancellationToken

戻り値

ValueTask<Object>

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

単一の JSON 値を表す UTF-8 エンコード テキストを、指定された型のインスタンスに、非同期に読み取ります。 ストリームは最後まで読み取られます。

public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);

public static System.Threading.Tasks.ValueTask<object> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);

static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>

Public Shared Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)

Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)

パラメーター

utf8Json

Stream

解析対象の JSON データ。

returnType

Type

変換元または変換先のオブジェクトの型。

options

JsonSerializerOptions

読み取り中の動作を制御するオプション。

cancellationToken

CancellationToken

読み取り操作を取り消すために使用できるキャンセル トークン。

戻り値

ValueTask<Object>

JSON 値の returnType 表現。

例外

ArgumentNullException

utf8Json または returnType が null です。

JsonException

JSON が無効です。

- または -

TValue は JSON と互換性がありません。

- または -

ストリームにデータが残っています。

NotSupportedException

returnType またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。

注釈

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Deserialize(Stream, Type, JsonSerializerOptions)スローされる例外に関するページを参照してください。

DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken)

1 つの JSON 値を表す UTF-8 でエンコードされたテキストを に TValue読み取ります。 Stream は完了まで読み取られます。

public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);

static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>

Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)

型パラメーター

TValue

JSON 値を逆シリアル化する型。

パラメーター

utf8Json

Stream

解析する JSON データ。

jsonTypeInfo

JsonTypeInfo<TValue>

変換する型に関するメタデータ。

cancellationToken

CancellationToken

CancellationToken読み取り操作を取り消すために使用できる 。

戻り値

ValueTask<TValue>

JSON 値の TValue 表現。

例外

ArgumentNullException

utf8Json または jsonTypeInfo が null です。

JsonException

JSON が無効であるか、 TValue JSON と互換性がないか、Stream に残りのデータがあります。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

単一の JSON 値を表す UTF-8 エンコード テキストを、ジェネリック型パラメーターで指定された型のインスタンスに、非同期に読み取ります。 ストリームは最後まで読み取られます。

public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);

public static System.Threading.Tasks.ValueTask<TValue> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);

static member DeserializeAsync : System.IO.Stream * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>

Public Shared Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)

Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)

型パラメーター

TValue

JSON 値のターゲット型。

パラメーター

utf8Json

Stream

解析対象の JSON データ。

options

JsonSerializerOptions

読み取り中の動作を制御するオプション。

cancellationToken

CancellationToken

読み取り操作を取り消すために使用できるトークン。

戻り値

ValueTask<TValue>

JSON 値の TValue 表現。

例外

JsonException

JSON が無効です。

- または -

TValue は JSON と互換性がありません。

- または -

ストリームにデータが残っています。

NotSupportedException

TValue またはそのシリアル化可能なメンバーに対して互換性のある JsonConverter はありません。

ArgumentNullException

utf8Json は null です。

注釈

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。