JsonSerializer.SerializeAsync メソッド

定義

名前空間:

System.Text.Json

アセンブリ:

System.Text.Json.dll

オーバーロード

SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、PipeWriterに書き込みます。
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)	指定した型の値を UTF-8 でエンコードされた JSON テキストに非同期的に変換し、指定したストリームに書き込みます。
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、PipeWriterに書き込みます。
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、PipeWriterに書き込みます。
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、PipeWriterに書き込みます。
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、PipeWriterに書き込みます。
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)	ジェネリック型パラメーターで指定された型の値を UTF-8 でエンコードされた JSON テキストに非同期的に変換し、ストリームに書き込みます。
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)	指定された値を UTF-8 でエンコードされた JSON テキストに変換し、Streamに書き込みます。

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

ソース:

JsonSerializer.Write.Stream.cs

指定された値を 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。

戻り値

Task

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

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json、inputType、または context が null。

NotSupportedException

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

OperationCanceledException

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

注釈

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

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.Task

Public 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。

戻り値

Task

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

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json、inputType、または context が null。

NotSupportedException

互換性のある JsonConverter はありません

inputType またはそのシリアル化可能なメンバーの場合。

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

ソース:

JsonSerializer.Write.Stream.cs

指定した型の値を 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);

static member SerializeAsync : System.IO.Stream * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.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

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

戻り値

Task

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

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json または inputType が null。

NotSupportedException

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

OperationCanceledException

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

注釈

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

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

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

ソース:

JsonSerializer.Write.Stream.cs

指定された値を 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。

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

InvalidCastException

value は jsonTypeInfoの種類と一致しません。

OperationCanceledException

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

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.Task

Public 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。

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

InvalidCastException

value は jsonTypeInfoの種類と一致しません。

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

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

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);

static member SerializeAsync : System.IO.Pipelines.PipeWriter * obj * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public 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。

戻り値

Task

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

例外

ArgumentException

inputType は valueと互換性がありません。

ArgumentNullException

utf8Json または inputType が null。

NotSupportedException

互換性のある JsonConverter はありません

inputType またはそのシリアル化可能なメンバーの場合。

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

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

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);

static member SerializeAsync : System.IO.Pipelines.PipeWriter * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public 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。

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

NotSupportedException

互換性のある JsonConverter はありません

TValue またはそのシリアル化可能なメンバーの場合。

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.Task

Public 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。

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

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

ソース:

JsonSerializer.Write.Stream.cs

ジェネリック型パラメーターで指定された型の値を 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);

static member SerializeAsync : System.IO.Stream * 'Value * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.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

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

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

NotSupportedException

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

OperationCanceledException

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

注釈

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

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

ソース:

JsonSerializer.Write.Stream.cs

指定された値を 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。

戻り値

Task

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

例外

ArgumentNullException

utf8Json は nullです。

NotSupportedException

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

OperationCanceledException

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