JsonSerializer.SerializeAsync Método

Definición

Espacio de nombres:

System.Text.Json

Ensamblado:

System.Text.Json.dll

Paquete:

System.Text.Json v9.0.0-rc.2.24473.5

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)

Source:

JsonSerializer.Write.Stream.cs

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.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

utf8Json

Stream

El UTF-8 Stream 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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json, inputTypeo context es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

OperationCanceledException

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).

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.Task

Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As Task

Pará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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json, inputTypeo context es null.

NotSupportedException

No hay JsonConverter compatibles

para inputType o sus miembros serializables.

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

Source:

JsonSerializer.Write.Stream.cs

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);

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

Pará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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json o inputType es null.

NotSupportedException

No hay JsonConverter compatibles para inputType ni sus miembros serializables.

OperationCanceledException

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).

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Source:

JsonSerializer.Write.Stream.cs

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.Task

Public Function SerializeAsync (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Task

Parámetros

utf8Json

Stream

El UTF-8 Stream 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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

InvalidCastException

value no coincide con el tipo de jsonTypeInfo.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

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.Task

Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Task

Pará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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

InvalidCastException

value no coincide con el tipo de jsonTypeInfo.

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.Task

Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Pará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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentException

inputType no es compatible con value.

ArgumentNullException

utf8Json o inputType es null.

NotSupportedException

No hay JsonConverter compatibles

para inputType o sus miembros serializables.

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.Task

Public Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, 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

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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

NotSupportedException

No hay JsonConverter compatibles

para TValue o sus miembros serializables.

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.Task

Public Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, 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

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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)

Source:

JsonSerializer.Write.Stream.cs

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);

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

Pará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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

OperationCanceledException

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.

SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)

Source:

JsonSerializer.Write.Stream.cs

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.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

utf8Json

Stream

El UTF-8 Stream 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

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

utf8Json es null.

NotSupportedException

No hay JsonConverter compatibles para TValue ni sus miembros serializables.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.