JsonSerializer.SerializeAsync Metoda

Definice

Obor názvů:

System.Text.Json

Sestavení:

System.Text.Json.dll

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, 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.
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<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.
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(Stream, Object, Type, JsonSerializerContext, CancellationToken)

Zdroj:

JsonSerializer.Write.Stream.cs

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

utf8Json

Stream

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

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentException

inputType není kompatibilní s value.

ArgumentNullException

utf8Json, inputTypenebo context je null.

NotSupportedException

Není kompatibilní JsonConverter pro inputType nebo jeho serializovatelné členy.

OperationCanceledException

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

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

Zdroj:

JsonSerializer.Write.Stream.cs

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

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

Parametry

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

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentException

inputType není kompatibilní s value.

ArgumentNullException

utf8Json nebo inputType je null.

NotSupportedException

Není kompatibilní JsonConverter pro inputType nebo jeho serializovatelné členy.

OperationCanceledException

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

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Zdroj:

JsonSerializer.Write.Stream.cs

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

utf8Json

Stream

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

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentNullException

utf8Json je null.

InvalidCastException

value neodpovídá typu jsonTypeInfo.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

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

Zdroj:

JsonSerializer.Write.Stream.cs

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

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

Parametry 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

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentNullException

utf8Json je null.

NotSupportedException

Není kompatibilní JsonConverter pro TValue nebo jeho serializovatelné členy.

OperationCanceledException

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.

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

Zdroj:

JsonSerializer.Write.Stream.cs

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

utf8Json

Stream

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

Task

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

ArgumentNullException

utf8Json je null.

NotSupportedException

Není kompatibilní JsonConverter pro TValue nebo jeho serializovatelné členy.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.