JsonSerializer.DeserializeAsync メソッド

定義

名前空間:

System.Text.Json

アセンブリ:

System.Text.Json.dll

オーバーロード

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

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

ソース:

JsonSerializer.Read.Stream.cs

1 つの JSON 値を表す UTF-8 でエンコードされたテキストを、jsonTypeInfoで指定されたインスタンスに読み取ります。 Stream は読み取って完了します。

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

解析する JSON データ。

jsonTypeInfo

JsonTypeInfo

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

cancellationToken

CancellationToken

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

戻り値

ValueTask<Object>

JSON 値の jsonTypeInfo 表現。

例外

ArgumentNullException

utf8Json または jsonTypeInfo が null。

JsonException

JSON が無効であるか、ストリームに残りのデータがある場合。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

ソース:

JsonSerializer.Read.Stream.cs

1 つの 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);

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

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 はありません。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

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

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

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

ソース:

JsonSerializer.Read.Stream.cs

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 と互換性がない、またはストリームに残りのデータがある。

NotSupportedException

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

InvalidOperationException

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

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

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

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

ソース:

JsonSerializer.Read.Stream.cs

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 はありません。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

ソース:

JsonSerializer.Read.Stream.cs

単一の 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);

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

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です。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

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