JsonSerializer.SerializeAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le Stream. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le PipeWriter. |
| SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Convertit de façon asynchrone la valeur d’un type spécifié en texte JSON encodé en UTF-8 et l’écrit dans le flux spécifié. |
| SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le Stream. |
| SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le PipeWriter. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le PipeWriter. |
| SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Convertit de façon asynchrone une valeur d’un type spécifié par un paramètre de type générique en texte JSON encodé en UTF-8 et l’écrit dans un flux. |
| SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres
- value
- Object
Valeur à convertir.
- inputType
- Type
Type du value à convertir.
- context
- JsonSerializerContext
Fournisseur de métadonnées pour les types sérialisables.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
inputType n’est pas compatible avec value.
utf8Json, inputTypeou context est null.
Il n’existe aucune JsonConverter compatible pour inputType ou ses membres sérialisables.
Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.
Remarques
Cette méthode stocke dans la tâche toutes les exceptions non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de façon synchrone. Pour les exceptions stockées, consultez les exceptions levées par Serialize(Stream, Object, Type, JsonSerializerContext).
S’applique à
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres
- utf8Json
- PipeWriter
L’UTF-8 PipeWriter à écrire.
- value
- Object
Valeur à convertir.
- inputType
- Type
Type du value à convertir.
- context
- JsonSerializerContext
Fournisseur de métadonnées pour les types sérialisables.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
inputType n’est pas compatible avec value.
utf8Json, inputTypeou context est null.
Il n’existe aucune JsonConverter compatible
pour inputType ou ses membres sérialisables.
S’applique à
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Convertit de façon asynchrone la valeur d’un type spécifié en texte JSON encodé en UTF-8 et l’écrit dans le flux spécifié.
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 TaskParamètres
- utf8Json
- Stream
Flux UTF-8 à écrire.
- value
- Object
Valeur à convertir.
- inputType
- Type
Type du value à convertir.
- options
- JsonSerializerOptions
Options pour contrôler le comportement de sérialisation.
- cancellationToken
- CancellationToken
Jeton qui peut être utilisé pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
inputType n’est pas compatible avec value.
utf8Json ou inputType est null.
Il n’existe aucune JsonConverter compatible pour inputType ou ses membres sérialisables.
Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.
Remarques
Pour plus d’informations, consultez Comment sérialiser et désérialiser json.
Cette méthode stocke dans la tâche toutes les exceptions non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de façon synchrone. Pour les exceptions stockées, consultez les exceptions levées par Serialize(Stream, Object, Type, JsonSerializerOptions).
S’applique à
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres
- value
- Object
Valeur à convertir.
- jsonTypeInfo
- JsonTypeInfo
Métadonnées sur le type à convertir.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
value ne correspond pas au type de jsonTypeInfo.
Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.
S’applique à
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres
- utf8Json
- PipeWriter
L’UTF-8 PipeWriter à écrire.
- value
- Object
Valeur à convertir.
- jsonTypeInfo
- JsonTypeInfo
Métadonnées sur le type à convertir.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
value ne correspond pas au type de jsonTypeInfo.
S’applique à
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres
- utf8Json
- PipeWriter
L’UTF-8 PipeWriter à écrire.
- value
- Object
Valeur à convertir.
- inputType
- Type
Type du value à convertir.
- options
- JsonSerializerOptions
Options permettant de contrôler le comportement de conversion.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
inputType n’est pas compatible avec value.
utf8Json ou inputType est null.
Il n’existe aucune JsonConverter compatible
pour inputType ou ses membres sérialisables.
S’applique à
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres de type
- TValue
Type de la valeur à sérialiser.
Paramètres
- utf8Json
- PipeWriter
L’UTF-8 PipeWriter à écrire.
- value
- TValue
Valeur à convertir.
- options
- JsonSerializerOptions
Options permettant de contrôler le comportement de conversion.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
Il n’existe aucune JsonConverter compatible
pour TValue ou ses membres sérialisables.
S’applique à
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres de type
- TValue
Type de la valeur à sérialiser.
Paramètres
- utf8Json
- PipeWriter
L’UTF-8 PipeWriter à écrire.
- value
- TValue
Valeur à convertir.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Métadonnées sur le type à convertir.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
S’applique à
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
Convertit de façon asynchrone une valeur d’un type spécifié par un paramètre de type générique en texte JSON encodé en UTF-8 et l’écrit dans un flux.
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 TaskParamètres de type
- TValue
Type de la valeur à sérialiser.
Paramètres
- utf8Json
- Stream
Flux UTF-8 à écrire.
- value
- TValue
Valeur à convertir.
- options
- JsonSerializerOptions
Options pour contrôler le comportement de sérialisation.
- cancellationToken
- CancellationToken
Jeton qui peut être utilisé pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
Il n’existe aucune JsonConverter compatible pour TValue ou ses membres sérialisables.
Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.
Remarques
Pour plus d’informations, consultez Comment sérialiser et désérialiser json.
S’applique à
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Convertit la valeur fournie en texte JSON encodé en UTF-8 et l’écrit dans le 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 TaskParamètres de type
- TValue
Type de la valeur à sérialiser.
Paramètres
- value
- TValue
Valeur à convertir.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Métadonnées sur le type à convertir.
- cancellationToken
- CancellationToken
La CancellationToken qui peut être utilisée pour annuler l’opération d’écriture.
Retours
Tâche qui représente l’opération d’écriture asynchrone.
Exceptions
utf8Json est null.
Il n’existe aucune JsonConverter compatible pour TValue ou ses membres sérialisables.
Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.
