JsonSerializer.SerializeAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no Stream. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no PipeWriter. |
| SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Converte de forma assíncrona o valor de um tipo especificado em texto JSON codificado em UTF-8 e grava-o no fluxo especificado. |
| SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no Stream. |
| SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no PipeWriter. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no PipeWriter. |
| SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Converte de forma assíncrona um valor de um tipo especificado por um parâmetro de tipo genérico em texto JSON codificado em UTF-8 e grava-o em um fluxo. |
| SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros
- value
- Object
O valor a ser convertido.
- inputType
- Type
O tipo do value a ser convertido.
- context
- JsonSerializerContext
Um provedor de metadados para tipos serializáveis.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
inputType não é compatível com value.
utf8Json, inputTypeou context é null.
Não há JsonConverter compatíveis para inputType ou seus membros serializáveis.
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Comentários
Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Serialize(Stream, Object, Type, JsonSerializerContext).
Aplica-se a
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
- Origem:
- JsonSerializer.Write.Pipe.cs
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros
- utf8Json
- PipeWriter
O PipeWriter UTF-8 para o qual gravar.
- value
- Object
O valor a ser convertido.
- inputType
- Type
O tipo do value a ser convertido.
- context
- JsonSerializerContext
Um provedor de metadados para tipos serializáveis.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
inputType não é compatível com value.
utf8Json, inputTypeou context é null.
Não há JsonConverter compatíveis
para inputType ou seus membros serializáveis.
Aplica-se a
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Converte de forma assíncrona o valor de um tipo especificado em texto JSON codificado em UTF-8 e grava-o no fluxo especificado.
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 TaskParâmetros
- utf8Json
- Stream
O fluxo UTF-8 para o qual gravar.
- value
- Object
O valor a ser convertido.
- inputType
- Type
O tipo do value a ser convertido.
- options
- JsonSerializerOptions
Opções para controlar o comportamento de serialização.
- cancellationToken
- CancellationToken
Um token que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
inputType não é compatível com value.
utf8Json ou inputType é null.
Não há JsonConverter compatíveis para inputType ou seus membros serializáveis.
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Comentários
Para obter mais informações, consulte Como serializar e desserializarJSON.
Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Serialize(Stream, Object, Type, JsonSerializerOptions).
Aplica-se a
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros
- value
- Object
O valor a ser convertido.
- jsonTypeInfo
- JsonTypeInfo
Metadados sobre o tipo a ser convertido.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
value não corresponde ao tipo de jsonTypeInfo.
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Aplica-se a
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
- Origem:
- JsonSerializer.Write.Pipe.cs
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros
- utf8Json
- PipeWriter
O PipeWriter UTF-8 para o qual gravar.
- value
- Object
O valor a ser convertido.
- jsonTypeInfo
- JsonTypeInfo
Metadados sobre o tipo a ser convertido.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
value não corresponde ao tipo de jsonTypeInfo.
Aplica-se a
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
- Origem:
- JsonSerializer.Write.Pipe.cs
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros
- utf8Json
- PipeWriter
O PipeWriter UTF-8 para o qual gravar.
- value
- Object
O valor a ser convertido.
- inputType
- Type
O tipo do value a ser convertido.
- options
- JsonSerializerOptions
Opções para controlar o comportamento de conversão.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
inputType não é compatível com value.
utf8Json ou inputType é null.
Não há JsonConverter compatíveis
para inputType ou seus membros serializáveis.
Aplica-se a
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
- Origem:
- JsonSerializer.Write.Pipe.cs
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros de tipo
- TValue
O tipo do valor a ser serializado.
Parâmetros
- utf8Json
- PipeWriter
O PipeWriter UTF-8 para o qual gravar.
- value
- TValue
O valor a ser convertido.
- options
- JsonSerializerOptions
Opções para controlar o comportamento de conversão.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
Aplica-se a
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
- Origem:
- JsonSerializer.Write.Pipe.cs
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros de tipo
- TValue
O tipo do valor a ser serializado.
Parâmetros
- utf8Json
- PipeWriter
O PipeWriter UTF-8 para o qual gravar.
- value
- TValue
O valor a ser convertido.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadados sobre o tipo a ser convertido.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
Aplica-se a
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
Converte de forma assíncrona um valor de um tipo especificado por um parâmetro de tipo genérico em texto JSON codificado em UTF-8 e grava-o em um fluxo.
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 TaskParâmetros de tipo
- TValue
O tipo do valor a ser serializado.
Parâmetros
- utf8Json
- Stream
O fluxo UTF-8 para o qual gravar.
- value
- TValue
O valor a ser convertido.
- options
- JsonSerializerOptions
Opções para controlar o comportamento de serialização.
- cancellationToken
- CancellationToken
Um token que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
Não há JsonConverter compatíveis para TValue ou seus membros serializáveis.
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Comentários
Para obter mais informações, consulte Como serializar e desserializarJSON.
Aplica-se a
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Converte o valor fornecido em texto JSON codificado em UTF-8 e grava-o no 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 TaskParâmetros de tipo
- TValue
O tipo do valor a ser serializado.
Parâmetros
- value
- TValue
O valor a ser convertido.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadados sobre o tipo a ser convertido.
- cancellationToken
- CancellationToken
O CancellationToken que pode ser usado para cancelar a operação de gravação.
Retornos
Uma tarefa que representa a operação de gravação assíncrona.
Exceções
utf8Json é null.
Não há JsonConverter compatíveis para TValue ou seus membros serializáveis.
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
