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 .Stream |
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en .Stream |
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Convierte de forma asincrónica el valor de un tipo especificado en texto JSON con codificación UTF-8 y lo escribe en la secuencia especificada. |
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en .Stream |
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 a texto JSON con codificación UTF-8 y lo escribe en una secuencia. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en .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
Parámetros
- value
- Object
Valor que se va a convertir.
- inputType
- Type
Tipo de value
que se va a convertir.
- context
- JsonSerializerContext
Proveedor de metadatos para tipos serializables.
- cancellationToken
- CancellationToken
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
, inputType
o context
es null
.
No hay ningún JsonConverter compatible para inputType
o 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 que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Serialize(Stream, Object, Type, JsonSerializerContext).
Se aplica a
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en .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
Parámetros
- value
- Object
Valor que se va a convertir.
- jsonTypeInfo
- JsonTypeInfo
Metadatos sobre el tipo que se va a convertir.
- cancellationToken
- CancellationToken
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(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Convierte de forma asincrónica el valor de un tipo especificado en texto JSON con codificación 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.Task
Public Shared Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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
Parámetros
- utf8Json
- Stream
Secuencia con codificación UTF-8 en la que se va a escribir.
- value
- Object
Valor que se va a convertir.
- inputType
- Type
Tipo de value
que se va a convertir.
- options
- JsonSerializerOptions
Opciones para controlar el comportamiento de la serialización.
- cancellationToken
- CancellationToken
Token que puede usarse 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 ningún JsonConverter compatible para inputType
o 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 que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Serialize(Stream, Object, Type, JsonSerializerOptions).
Se aplica a
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Convierte el valor proporcionado en texto JSON codificado UTF-8 y lo escribe en .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
Pará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
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 ningún JsonConverter compatible para TValue
o sus miembros serializables.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
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 a texto JSON con codificación 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.Task
Public Shared Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Public Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Parámetros de tipo
- TValue
Tipo del valor que se va a serializar.
Parámetros
- utf8Json
- Stream
Secuencia con codificación 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 la serialización.
- cancellationToken
- CancellationToken
Token que puede usarse para cancelar la operación de escritura.
Devoluciones
Tarea que representa la operación de escritura asincrónica.
Excepciones
utf8Json
es null
.
No hay ningún JsonConverter compatible para TValue
o 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
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de