JsonSerializer.DeserializeAsync 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í
DeserializeAsync(Stream, JsonTypeInfo, CancellationToken) |
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do instance určené |
DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken) |
Asynchronně čte zakódovaný text UTF-8 představující jednu hodnotu JSON do instance zadaného typu. Stream se přečte do dokončení. |
DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken) |
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do |
DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken) |
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do |
DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken) |
Asynchronně čte zakódovaný text UTF-8 představující jednu hodnotu JSON do instance typu určeného parametrem obecného typu. Stream se přečte do dokončení. |
DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do instance určené jsonTypeInfo
.
Stream se přečte do dokončení.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);
static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>
Public Function DeserializeAsync (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)
Parametry
- utf8Json
- Stream
Data JSON, která se mají analyzovat
- jsonTypeInfo
- JsonTypeInfo
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
CancellationToken, který lze použít ke zrušení operace čtení.
Návraty
Reprezentace jsonTypeInfo
hodnoty JSON.
Výjimky
utf8Json
nebo jsonTypeInfo
je null
.
JSON je neplatný nebo pokud ve streamu zbývá data.
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
Platí pro
DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)
Asynchronně čte zakódovaný text UTF-8 představující jednu hodnotu JSON do instance zadaného typu. Stream se přečte do dokončení.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.ValueTask<object> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);
static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>
Public Shared Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)
Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)
Parametry
- utf8Json
- Stream
Data JSON, která se mají analyzovat.
- returnType
- Type
Typ objektu, na který se má převést a vrátit.
- options
- JsonSerializerOptions
Možnosti řízení chování při čtení
- cancellationToken
- CancellationToken
Token zrušení, který lze použít ke zrušení operace čtení.
Návraty
Reprezentace returnType
hodnoty JSON.
Výjimky
utf8Json
nebo returnType
je null
.
Json je neplatný.
-nebo-
TValue
není kompatibilní s json.
-nebo-
Ve streamu jsou zbývající data.
Není kompatibilní JsonConverter pro returnType
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é Deserialize(Stream, Type, JsonSerializerOptions).
Platí pro
DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do returnType
.
Stream se přečte do dokončení.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.Serialization.JsonSerializerContext context, System.Threading.CancellationToken cancellationToken = default);
static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.Serialization.JsonSerializerContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>
Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)
Parametry
- utf8Json
- Stream
Data JSON, která se mají analyzovat
- returnType
- Type
Typ objektu, na který se má převést a vrátit.
- context
- JsonSerializerContext
Zprostředkovatel metadat pro serializovatelné typy.
- cancellationToken
- CancellationToken
CancellationToken, který lze použít ke zrušení operace čtení.
Návraty
Reprezentace returnType
hodnoty JSON.
Výjimky
utf8Json
, returnType
nebo context
je null
.
JSON je neplatný, returnType
není kompatibilní s JSON nebo ve streamu jsou zbývající data.
Není kompatibilní JsonConverter pro returnType
nebo jeho serializovatelné členy.
Metoda GetTypeInfo(Type) na poskytnutém context
nevrátila kompatibilní JsonTypeInfo pro returnType
.
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é Deserialize(Stream, Type, JsonSerializerContext).
Platí pro
DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken)
Přečte kódovaný text UTF-8 představující jednu hodnotu JSON do TValue
.
Stream se přečte do dokončení.
public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);
static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>
Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)
Parametry typu
- TValue
Typ pro deserializaci hodnoty JSON do.
Parametry
- utf8Json
- Stream
Data JSON, která se mají analyzovat
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadata o typu, který chcete převést.
- cancellationToken
- CancellationToken
CancellationToken, který lze použít ke zrušení operace čtení.
Návraty
Reprezentace TValue
hodnoty JSON.
Výjimky
utf8Json
nebo jsonTypeInfo
je null
.
Json je neplatný, TValue
není kompatibilní s JSON nebo ve streamu jsou zbývající data.
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.
Platí pro
DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)
Asynchronně čte zakódovaný text UTF-8 představující jednu hodnotu JSON do instance typu určeného parametrem obecného typu. Stream se přečte do dokončení.
public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.ValueTask<TValue> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);
static member DeserializeAsync : System.IO.Stream * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>
Public Shared Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)
Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)
Parametry typu
- TValue
Cílový typ hodnoty JSON.
Parametry
- utf8Json
- Stream
Data JSON, která se mají analyzovat.
- options
- JsonSerializerOptions
Možnosti řízení chování při čtení
- cancellationToken
- CancellationToken
Token, který lze použít ke zrušení operace čtení.
Návraty
Reprezentace TValue
hodnoty JSON.
Výjimky
Json je neplatný.
-nebo-
TValue
není kompatibilní s json.
-nebo-
Ve streamu jsou zbývající data.
Není kompatibilní JsonConverter pro TValue
nebo jeho serializovatelné členy.
utf8Json
je null
.
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.