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.
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 TaskParametry
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value, který chcete převést.
- context
- JsonSerializerContext
Zprostředkovatel metadat pro serializovatelné typy.
- cancellationToken
- CancellationToken
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.
utf8Json, inputTypenebo context je null.
Není kompatibilní JsonConverter pro inputType nebo jeho serializovatelné členy.
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
Poznámky
Tato metoda ukládá do úlohy všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. U uložených výjimek se podívejte na výjimky vyvolané Serialize(Stream, Object, Type, JsonSerializerContext).
Platí pro
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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 TaskParametry
- utf8Json
- PipeWriter
UTF-8 PipeWriter k zápisu.
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value, který chcete převést.
- context
- JsonSerializerContext
Zprostředkovatel metadat pro serializovatelné typy.
- cancellationToken
- CancellationToken
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.
utf8Json, inputTypenebo context je null.
Není kompatibilní JsonConverter
pro inputType nebo jeho serializovatelné členy.
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 ho 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.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 TaskParametry
- utf8Json
- Stream
Datový proud UTF-8 pro zápis.
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value, který 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
inputType není kompatibilní s value.
utf8Json nebo inputType je null.
Není kompatibilní JsonConverter pro inputType nebo jeho serializovatelné členy.
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
Poznámky
Další informace naleznete v tématu Jak serializovat a deserializovat JSON.
Tato metoda ukládá do úlohy všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. U uložených výjimek se podívejte na výjimky vyvolané Serialize(Stream, Object, Type, JsonSerializerOptions).
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.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As TaskParametry
- value
- Object
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
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 do vrácené úlohy.
Platí pro
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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 TaskParametry
- utf8Json
- PipeWriter
UTF-8 PipeWriter k zápisu.
- value
- Object
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
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.
Platí pro
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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 TaskParametry
- utf8Json
- PipeWriter
UTF-8 PipeWriter k zápisu.
- value
- Object
Hodnota, kterou chcete převést.
- inputType
- Type
Typ value, který chcete převést.
- options
- JsonSerializerOptions
Možnosti pro řízení chování převodu
- cancellationToken
- CancellationToken
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.
utf8Json nebo inputType je null.
Není kompatibilní JsonConverter
pro inputType nebo jeho serializovatelné členy.
Platí pro
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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 TaskParametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- utf8Json
- PipeWriter
UTF-8 PipeWriter k zápisu.
- value
- TValue
Hodnota, kterou chcete převést.
- options
- JsonSerializerOptions
Možnosti pro řízení chování převodu
- cancellationToken
- CancellationToken
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.
Platí pro
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
Převede zadanou hodnotu na text JSON s kódováním UTF-8 a zapíše ji do 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 TaskParametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- utf8Json
- PipeWriter
UTF-8 PipeWriter k zápisu.
- value
- TValue
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
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.
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 ho 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.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 TaskParametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- utf8Json
- Stream
Datový proud UTF-8 pro zápis.
- 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.
Není kompatibilní JsonConverter pro TValue nebo jeho serializovatelné členy.
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
Poznámky
Další informace naleznete v tématu Jak serializovat a deserializovat JSON.
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.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As TaskParametry typu
- TValue
Typ hodnoty, která se má serializovat.
Parametry
- value
- TValue
Hodnota, kterou chcete převést.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
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.
Není kompatibilní JsonConverter pro TValue nebo jeho serializovatelné členy.
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
