JsonSerializer.DeserializeAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| DeserializeAsync(Stream, JsonTypeInfo, CancellationToken) |
1 つの JSON 値を表す UTF-8 でエンコードされたテキストを、 |
| DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken) |
1 つの JSON 値を表す UTF-8 でエンコードされたテキストを、指定した型のインスタンスに非同期的に読み取ります。 ストリームは完了まで読み取られます。 |
| DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken) |
1 つの JSON 値を表す UTF-8 でエンコードされたテキストを |
| DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken) |
1 つの JSON 値を表す UTF-8 でエンコードされたテキストを |
| DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken) |
単一の JSON 値を表す UTF-8 でエンコードされたテキストを、ジェネリック型パラメーターで指定された型のインスタンスに非同期的に読み取ります。 ストリームは完了まで読み取られます。 |
DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)
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。
戻り値
JSON 値の jsonTypeInfo 表現。
例外
utf8Json または jsonTypeInfo が null。
JSON が無効であるか、ストリームに残りのデータがある場合。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)
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);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
読み取り操作を取り消すために使用できるキャンセル トークン。
戻り値
JSON 値の returnType 表現。
例外
utf8Json または returnType が null。
returnType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、Deserialize(Stream, Type, JsonSerializerOptions)によってスローされる例外を参照してください。
適用対象
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。
戻り値
JSON 値の returnType 表現。
例外
utf8Json、returnType、または context が null。
JSON が無効であるか、returnType が JSON と互換性がない、またはストリームに残りのデータがある。
returnType またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。
指定された context の GetTypeInfo(Type) メソッドは、returnTypeの互換性のある JsonTypeInfo を返しませんでした。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、Deserialize(Stream, Type, JsonSerializerContext)によってスローされる例外を参照してください。
適用対象
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。
戻り値
JSON 値の TValue 表現。
例外
utf8Json または jsonTypeInfo が null。
JSON が無効です。TValue は JSON と互換性がありません。または、Stream に残りのデータがあります。
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
読み取り操作を取り消すために使用できるトークン。
戻り値
JSON 値の TValue 表現。
例外
TValue またはそのシリアル化可能なメンバーに互換性のある JsonConverter はありません。
utf8Jsonは nullです。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
詳細については、「JSONをシリアル化および逆シリアル化する方法」を参照してください。
適用対象
.NET