JsonSerializer.SerializeAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el PipeWriter. |
| SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Convierte de forma asincrónica el valor de un tipo especificado en texto JSON codificado UTF-8 y lo escribe en la secuencia especificada. |
| SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream. |
| SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el PipeWriter. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el PipeWriter. |
| SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Convierte de forma asincrónica un valor de un tipo especificado por un parámetro de tipo genérico en texto JSON codificado UTF-8 y lo escribe en una secuencia. |
| SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
Valor que se va a convertir.
- inputType
- Type
Tipo del value que se va a convertir.
- context
- JsonSerializerContext
Proveedor de metadatos para tipos serializables.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
inputType no es compatible con value.
utf8Json, inputTypeo context es null.
No hay JsonConverter compatibles para inputType ni sus miembros serializables.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Comentarios
Este método almacena en la tarea que devuelve todas las excepciones de no uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por Serialize(Stream, Object, Type, JsonSerializerContext).
Se aplica a
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
El UTF-8 PipeWriter en el que se va a escribir.
- value
- Object
Valor que se va a convertir.
- inputType
- Type
Tipo del value que se va a convertir.
- context
- JsonSerializerContext
Proveedor de metadatos para tipos serializables.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
inputType no es compatible con value.
utf8Json, inputTypeo context es null.
Se aplica a
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Convierte de forma asincrónica el valor de un tipo especificado en texto JSON codificado UTF-8 y lo escribe en la secuencia especificada.
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
Secuencia UTF-8 en la que se va a escribir.
- value
- Object
Valor que se va a convertir.
- inputType
- Type
Tipo del value que se va a convertir.
- options
- JsonSerializerOptions
Opciones para controlar el comportamiento de serialización.
- cancellationToken
- CancellationToken
Token que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
inputType no es compatible con value.
utf8Json o inputType es null.
No hay JsonConverter compatibles para inputType ni sus miembros serializables.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Comentarios
Para obtener más información, consulte Cómo serializar y deserializar JSON.
Este método almacena en la tarea que devuelve todas las excepciones de no uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por Serialize(Stream, Object, Type, JsonSerializerOptions).
Se aplica a
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
Valor que se va a convertir.
- jsonTypeInfo
- JsonTypeInfo
Metadatos sobre el tipo que se va a convertir.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
value no coincide con el tipo de jsonTypeInfo.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Se aplica a
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
El UTF-8 PipeWriter en el que se va a escribir.
- value
- Object
Valor que se va a convertir.
- jsonTypeInfo
- JsonTypeInfo
Metadatos sobre el tipo que se va a convertir.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
value no coincide con el tipo de jsonTypeInfo.
Se aplica a
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
El UTF-8 PipeWriter en el que se va a escribir.
- value
- Object
Valor que se va a convertir.
- inputType
- Type
Tipo del value que se va a convertir.
- options
- JsonSerializerOptions
Opciones para controlar el comportamiento de conversión.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
inputType no es compatible con value.
utf8Json o inputType es null.
Se aplica a
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
Tipo del valor que se va a serializar.
Parámetros
- utf8Json
- PipeWriter
El UTF-8 PipeWriter en el que se va a escribir.
- value
- TValue
Valor que se va a convertir.
- options
- JsonSerializerOptions
Opciones para controlar el comportamiento de conversión.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
Se aplica a
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
Tipo del valor que se va a serializar.
Parámetros
- utf8Json
- PipeWriter
El UTF-8 PipeWriter en el que se va a escribir.
- value
- TValue
Valor que se va a convertir.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadatos sobre el tipo que se va a convertir.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
Se aplica a
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
Convierte de forma asincrónica un valor de un tipo especificado por un parámetro de tipo genérico en texto JSON codificado UTF-8 y lo escribe en una secuencia.
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
Tipo del valor que se va a serializar.
Parámetros
- utf8Json
- Stream
Secuencia UTF-8 en la que se va a escribir.
- value
- TValue
Valor que se va a convertir.
- options
- JsonSerializerOptions
Opciones para controlar el comportamiento de serialización.
- cancellationToken
- CancellationToken
Token que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
No hay JsonConverter compatibles para TValue ni sus miembros serializables.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Comentarios
Para obtener más información, consulte Cómo serializar y deserializar JSON.
Se aplica a
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en el 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
Tipo del valor que se va a serializar.
Parámetros
- value
- TValue
Valor que se va a convertir.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadatos sobre el tipo que se va a convertir.
- cancellationToken
- CancellationToken
El CancellationToken que se puede usar para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json es null.
No hay JsonConverter compatibles para TValue ni sus miembros serializables.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
