JsonSerializer.SerializeAsync 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
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或 contextnull。
inputType 或其可序列化成员没有兼容的 JsonConverter。
取消令牌已取消。 此异常存储在返回的任务中。
注解
此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 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.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或 contextnull。
适用于
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.TaskPublic Shared Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic 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 或 inputTypenull。
inputType 或其可序列化成员没有兼容的 JsonConverter。
取消令牌已取消。 此异常存储在返回的任务中。
注解
有关详细信息，请参阅 如何序列化和反序列化 JSON。
此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 ArgumentException）仍同步引发。 有关存储的异常，请参阅 Serialize(Stream, Object, Type, JsonSerializerOptions)引发的异常。
适用于
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。
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.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 或 inputTypenull。
适用于
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.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。
适用于
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 文本，并将其写入流。
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.TaskPublic Shared Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic 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。
取消令牌已取消。 此异常存储在返回的任务中。
