JsonSerializer.SerializeAsync Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Přetížení
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do Stream. |
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Asynchronně převede hodnotu zadaného typu na text JSON s kódováním UTF-8 a zapíše ji do zadaného datového proudu. |
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do Stream. |
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Asynchronně převede hodnotu typu určeného parametrem obecného typu na text JSON s kódováním UTF-8 a zapíše ji do datového proudu. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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
Parametry
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value
převést.
- context
- JsonSerializerContext
Zprostředkovatel metadat pro serializovatelné typy.
- cancellationToken
- CancellationToken
Nástroj CancellationToken , který lze použít ke zrušení operace zápisu.
Návraty
Úloha, která představuje asynchronní operaci zápisu.
Výjimky
inputType
není kompatibilní s value
nástrojem .
utf8Json
, inputType
nebo context
je null
.
Neexistuje žádný kompatibilní JsonConverter pro inputType
serializovatelné členy nebo.
Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.
Poznámky
Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Serialize(Stream, Object, Type, JsonSerializerContext).
Platí pro
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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
Parametry
- value
- Object
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo
Metadata o typu, který se má převést.
- cancellationToken
- CancellationToken
Nástroj CancellationToken , který lze použít ke zrušení operace zápisu.
Návraty
Úloha, která představuje asynchronní operaci zápisu.
Výjimky
utf8Json
je null
.
value
neodpovídá typu jsonTypeInfo
.
Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.
Platí pro
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Asynchronně převede hodnotu zadaného typu na text JSON s kódováním UTF-8 a zapíše ji do zadaného datového proudu.
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
Parametry
- utf8Json
- Stream
Datový proud UTF-8, do který se má zapisovat.
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value
převést.
- options
- JsonSerializerOptions
Možnosti řízení chování serializace.
- cancellationToken
- CancellationToken
Token, který lze použít ke zrušení operace zápisu.
Návraty
Úloha, která představuje asynchronní operaci zápisu.
Výjimky
inputType
není kompatibilní s value
nástrojem .
utf8Json
nebo inputType
je null
.
Neexistuje žádný kompatibilní JsonConverter pro inputType
serializovatelné členy nebo.
Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.
Poznámky
Další informace najdete v tématu Jak serializovat a deserializovat JSON.
Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Serialize(Stream, Object, Type, JsonSerializerOptions).
Platí pro
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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
Parametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- value
- TValue
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadata o typu, který se má převést.
- cancellationToken
- CancellationToken
Nástroj CancellationToken , který lze použít ke zrušení operace zápisu.
Návraty
Úloha, která představuje asynchronní operaci zápisu.
Výjimky
utf8Json
je null
.
Neexistuje žádný kompatibilní JsonConverter pro TValue
serializovatelné členy nebo.
Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.
Platí pro
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
Asynchronně převede hodnotu typu určeného parametrem obecného typu na text JSON s kódováním UTF-8 a zapíše ji do datového proudu.
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
Parametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- utf8Json
- Stream
Datový proud UTF-8, do který se má zapisovat.
- value
- TValue
Hodnota, kterou chcete převést.
- options
- JsonSerializerOptions
Možnosti řízení chování serializace.
- cancellationToken
- CancellationToken
Token, který lze použít ke zrušení operace zápisu.
Návraty
Úloha, která představuje asynchronní operaci zápisu.
Výjimky
utf8Json
je null
.
Neexistuje žádný kompatibilní JsonConverter pro TValue
serializovatelné členy nebo.
Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.
Poznámky
Další informace najdete v tématu Jak serializovat a deserializovat JSON.
Platí pro
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro