JsonSerializer.SerializeAsync 方法

定义

命名空间:

System.Text.Json

程序集:

System.Text.Json.dll

重载

SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)	将所提供的值转换为 UTF-8 编码的 JSON 文本，并将其写入 Stream。
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)	将指定类型的值异步转换为 UTF-8 编码的 JSON 文本，并将其写入指定流。
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)	将所提供的值转换为 UTF-8 编码的 JSON 文本，并将其写入 Stream。
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)

Source:

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或 contextnull。

NotSupportedException

inputType 或其可序列化成员没有兼容的 JsonConverter。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 ArgumentException）仍同步引发。 有关存储的异常，请参阅 Serialize(Stream, Object, Type, JsonSerializerContext)引发的异常。

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

Source:

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 或 inputTypenull。

NotSupportedException

inputType 或其可序列化成员没有兼容的 JsonConverter。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

有关详细信息，请参阅 如何序列化和反序列化 JSON。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 ArgumentException）仍同步引发。 有关存储的异常，请参阅 Serialize(Stream, Object, Type, JsonSerializerOptions)引发的异常。

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Source:

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<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)

Source:

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)

Source:

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

取消令牌已取消。 此异常存储在返回的任务中。