JsonSerializer.SerializeAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
指定した型の値を UTF-8 でエンコードされた JSON テキストに非同期的に変換し、指定したストリームに書き込みます。
[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object value, Type inputType, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Taskstatic member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic Shared Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- utf8Json
- Stream
書き込む UTF-8 ストリーム。
- value
- Object
変換する値。
- inputType
- Type
変換する value の型。
- options
- JsonSerializerOptions
シリアル化の動作を制御するオプション。
- cancellationToken
- CancellationToken
書き込み操作を取り消すために使用できるトークン。
返品
非同期書き込み操作を表すタスク。
- 属性
例外
inputType と value には互換性がありません。
utf8Json または inputType が null。
inputTypeまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
詳細については、「 JSON をシリアル化および逆シリアル化する方法」を参照してください。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Serialize(Stream, Object, Type, JsonSerializerOptions)によってスローされる例外を参照してください。
適用対象
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 PipeWriterに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Pipelines.PipeWriter utf8Json, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Pipelines.PipeWriter * obj * Type * System.Text.Json.Serialization.JsonSerializerContext * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- utf8Json
- PipeWriter
書き込む UTF-8 PipeWriter 。
- value
- Object
変換する値。
- inputType
- Type
変換する value の型。
- context
- JsonSerializerContext
シリアル化可能な型のメタデータ プロバイダー。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
inputType と value には互換性がありません。
utf8Json、 inputType、または context が null。
inputTypeまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
適用対象
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object? value, Type inputType, System.Text.Json.Serialization.JsonSerializerContext context, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.Serialization.JsonSerializerContext * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- value
- Object
変換する値。
- inputType
- Type
変換する value の型。
- context
- JsonSerializerContext
シリアル化可能な型のメタデータ プロバイダー。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
inputType と value には互換性がありません。
utf8Json、 inputType、または context が null。
inputTypeまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Serialize(Stream, Object, Type, JsonSerializerContext)によってスローされる例外を参照してください。
適用対象
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Stream utf8Json, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Stream * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- value
- Object
変換する値。
- jsonTypeInfo
- JsonTypeInfo
変換する型に関するメタデータ。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
utf8Json は nullです。
value が jsonTypeInfoの型と一致しません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 PipeWriterに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Pipelines.PipeWriter utf8Json, object? value, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Pipelines.PipeWriter * obj * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- utf8Json
- PipeWriter
書き込む UTF-8 PipeWriter 。
- value
- Object
変換する値。
- jsonTypeInfo
- JsonTypeInfo
変換する型に関するメタデータ。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
utf8Json は nullです。
value が jsonTypeInfoの型と一致しません。
適用対象
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 PipeWriterに書き込みます。
[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync(System.IO.Pipelines.PipeWriter utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync(System.IO.Pipelines.PipeWriter utf8Json, object? value, Type inputType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Pipelines.PipeWriter * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Taskstatic member SerializeAsync : System.IO.Pipelines.PipeWriter * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Taskパラメーター
- utf8Json
- PipeWriter
書き込む UTF-8 PipeWriter 。
- value
- Object
変換する値。
- inputType
- Type
変換する value の型。
- options
- JsonSerializerOptions
変換動作を制御するオプション。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
- 属性
例外
inputType と value には互換性がありません。
utf8Json または inputType が null。
inputTypeまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
適用対象
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 PipeWriterに書き込みます。
[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Pipelines.PipeWriter utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Pipelines.PipeWriter utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Pipelines.PipeWriter * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Taskstatic member SerializeAsync : System.IO.Pipelines.PipeWriter * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task型パラメーター
- TValue
シリアル化する値の型。
パラメーター
- utf8Json
- PipeWriter
書き込む UTF-8 PipeWriter 。
- value
- TValue
変換する値。
- options
- JsonSerializerOptions
変換動作を制御するオプション。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
- 属性
例外
utf8Json は nullです。
TValueまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
適用対象
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 PipeWriterに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Pipelines.PipeWriter utf8Json, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Pipelines.PipeWriter * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As Task型パラメーター
- TValue
シリアル化する値の型。
パラメーター
- utf8Json
- PipeWriter
書き込む UTF-8 PipeWriter 。
- value
- TValue
変換する値。
- jsonTypeInfo
- JsonTypeInfo<TValue>
変換する型に関するメタデータ。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
utf8Json は nullです。
適用対象
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
ジェネリック型パラメーターで指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期的に変換し、ストリームに書き込みます。
[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")]
public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Stream utf8Json, TValue value, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Taskstatic member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("JSON serialization and deserialization might require types that cannot be statically analyzed. Use the overload that takes a JsonTypeInfo or JsonSerializerContext, or make sure all of the required types are preserved.")>]
static member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic Shared Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task型パラメーター
- TValue
シリアル化する値の型。
パラメーター
- utf8Json
- Stream
書き込む UTF-8 ストリーム。
- value
- TValue
変換する値。
- options
- JsonSerializerOptions
シリアル化の動作を制御するオプション。
- cancellationToken
- CancellationToken
書き込み操作を取り消すために使用できるトークン。
返品
非同期書き込み操作を表すタスク。
- 属性
例外
utf8Json は nullです。
TValueまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
詳細については、「 JSON をシリアル化および逆シリアル化する方法」を参照してください。
適用対象
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。
public static System.Threading.Tasks.Task SerializeAsync<TValue>(System.IO.Stream utf8Json, TValue value, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As Task型パラメーター
- TValue
シリアル化する値の型。
パラメーター
- value
- TValue
変換する値。
- jsonTypeInfo
- JsonTypeInfo<TValue>
変換する型に関するメタデータ。
- cancellationToken
- CancellationToken
書き込み操作の取り消しに使用できる CancellationToken 。
返品
非同期書き込み操作を表すタスク。
例外
utf8Json は nullです。
TValueまたはそのシリアル化可能なメンバーに互換性のあるJsonConverterはありません。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
