JsonSerializer.SerializeAsync メソッド

定義

オーバーロード

SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)

指定した値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

指定された値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。

SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)

指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期に変換し、指定されたストリームに書き込みます。

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

指定した値を UTF-8 でエンコードされた JSON テキストに変換し、 Streamに書き込みます。

SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)

ジェネリック型パラメーターによって指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期に変換し、ストリームに書き込みます。

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.Task
Public Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

utf8Json
Stream

書き込む UTF-8 Stream

value
Object

変換する値。

inputType
Type

変換対象の value の型。

context
JsonSerializerContext

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

cancellationToken
CancellationToken

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

戻り値

非同期の書き込み操作を表すタスク。

例外

inputTypevalue と互換性がありません。

utf8JsoninputType、または contextnull です。

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.Task
Public Function SerializeAsync (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

utf8Json
Stream

書き込む UTF-8 Stream

value
Object

変換する値。

jsonTypeInfo
JsonTypeInfo

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

cancellationToken
CancellationToken

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

戻り値

非同期の書き込み操作を表すタスク。

例外

utf8Jsonnull です。

value が の jsonTypeInfo型と一致しません。

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

適用対象

SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)

指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期に変換し、指定されたストリームに書き込みます。

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);
static member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Public 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

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

戻り値

非同期の書き込み操作を表すタスク。

例外

inputTypevalue と互換性がありません。

utf8Json または inputTypenull です。

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

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

注釈

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

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

適用対象

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.Task
Public Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As Task

型パラメーター

TValue

シリアル化する値の型。

パラメーター

utf8Json
Stream

書き込む UTF-8 Stream

value
TValue

変換する値。

jsonTypeInfo
JsonTypeInfo<TValue>

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

cancellationToken
CancellationToken

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

戻り値

非同期の書き込み操作を表すタスク。

例外

utf8Jsonnullです。

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

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

適用対象

SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)

ジェネリック型パラメーターによって指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期に変換し、ストリームに書き込みます。

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);
static member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Public 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

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

戻り値

非同期の書き込み操作を表すタスク。

例外

utf8Jsonnullです。

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

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

注釈

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

適用対象