Freigeben über


JsonSerializer.DeserializeAsync Methode

Definition

Überlädt

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert darstellt, in einer Instanz, die durch die jsonTypeInfoangegeben wird. Der Stream wird nach Abschluss gelesen.

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

Liest asynchron den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einer Instanz eines angegebenen Typs darstellt. Der Datenstrom wird nach Abschluss gelesen.

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einem returnTypedarstellt. Der Stream wird nach Abschluss gelesen.

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

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einem TValuedarstellt. Der Stream wird nach Abschluss gelesen.

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

Liest asynchron den UTF-8-codierten Text, der einen einzelnen JSON-Wert in eine Instanz eines Typs darstellt, der durch einen generischen Typparameter angegeben wird. Der Datenstrom wird nach Abschluss gelesen.

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert darstellt, in einer Instanz, die durch die jsonTypeInfoangegeben wird. Der Stream wird nach Abschluss gelesen.

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)

Parameter

utf8Json
Stream

JSON-Daten, die analysiert werden sollen.

jsonTypeInfo
JsonTypeInfo

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

Die CancellationToken, die zum Abbrechen des Lesevorgangs verwendet werden kann.

Gibt zurück

Eine jsonTypeInfo Darstellung des JSON-Werts.

Ausnahmen

utf8Json oder jsonTypeInfo ist null.

Der JSON-Code ist ungültig oder wenn im Stream verbleibende Daten vorhanden sind.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Gilt für:

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs

Liest asynchron den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einer Instanz eines angegebenen Typs darstellt. Der Datenstrom wird nach Abschluss gelesen.

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)

Parameter

utf8Json
Stream

Die zu analysierenden JSON-Daten.

returnType
Type

Der Typ des objekts, in das konvertiert und zurückgegeben werden soll.

options
JsonSerializerOptions

Optionen zum Steuern des Verhaltens beim Lesen.

cancellationToken
CancellationToken

Ein Abbruchtoken, das zum Abbrechen des Lesevorgangs verwendet werden kann.

Gibt zurück

Eine returnType Darstellung des JSON-Werts.

Ausnahmen

utf8Json oder returnType ist null.

Der JSON-Code ist ungültig.

-oder-

TValue ist nicht mit dem JSON kompatibel.

-oder-

Es gibt verbleibende Daten im Datenstrom.

Es gibt keine kompatiblen JsonConverter für returnType oder die serialisierbaren Member.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Weitere Informationen finden Sie unter How to serialize and deserialize JSON.

Diese Methode speichert in der Aufgabe, die alle Nicht-Verwendungs-Ausnahmen zurückgibt, die das synchrone Gegenstück der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Verwendungs exceptions, z. B. ArgumentException, werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie in den von Deserialize(Stream, Type, JsonSerializerOptions)ausgelösten Ausnahmen.

Gilt für:

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einem returnTypedarstellt. Der Stream wird nach Abschluss gelesen.

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)

Parameter

utf8Json
Stream

JSON-Daten, die analysiert werden sollen.

returnType
Type

Der Typ des objekts, in das konvertiert und zurückgegeben werden soll.

context
JsonSerializerContext

Ein Metadatenanbieter für serialisierbare Typen.

cancellationToken
CancellationToken

Die CancellationToken, die zum Abbrechen des Lesevorgangs verwendet werden kann.

Gibt zurück

Eine returnType Darstellung des JSON-Werts.

Ausnahmen

utf8Json, returnTypeoder context ist null.

Der JSON-Code ist ungültig, der returnType ist nicht mit dem JSON kompatibel, oder es gibt verbleibende Daten im Stream.

Es gibt keine kompatiblen JsonConverter für returnType oder die serialisierbaren Member.

Die GetTypeInfo(Type) Methode für die bereitgestellte context hat keinen kompatiblen JsonTypeInfo für returnTypezurückgegeben.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Diese Methode speichert in der Aufgabe, die alle Nicht-Verwendungs-Ausnahmen zurückgibt, die das synchrone Gegenstück der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Verwendungs exceptions, z. B. ArgumentException, werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie in den von Deserialize(Stream, Type, JsonSerializerContext)ausgelösten Ausnahmen.

Gilt für:

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

Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs

Liest den UTF-8-codierten Text, der einen einzelnen JSON-Wert in einem TValuedarstellt. Der Stream wird nach Abschluss gelesen.

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)

Typparameter

TValue

Der Typ, in den der JSON-Wert deserialisiert werden soll.

Parameter

utf8Json
Stream

JSON-Daten, die analysiert werden sollen.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

Die CancellationToken, die zum Abbrechen des Lesevorgangs verwendet werden kann.

Gibt zurück

ValueTask<TValue>

Eine TValue Darstellung des JSON-Werts.

Ausnahmen

utf8Json oder jsonTypeInfo ist null.

Der JSON-Code ist ungültig, TValue nicht mit dem JSON kompatibel ist, oder es gibt verbleibende Daten im Stream.

Es gibt keine kompatiblen JsonConverter für TValue oder die serialisierbaren Member.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Gilt für:

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs
Quelle:
JsonSerializer.Read.Stream.cs

Liest asynchron den UTF-8-codierten Text, der einen einzelnen JSON-Wert in eine Instanz eines Typs darstellt, der durch einen generischen Typparameter angegeben wird. Der Datenstrom wird nach Abschluss gelesen.

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)

Typparameter

TValue

Der Zieltyp des JSON-Werts.

Parameter

utf8Json
Stream

Die zu analysierenden JSON-Daten.

options
JsonSerializerOptions

Optionen zum Steuern des Verhaltens beim Lesen.

cancellationToken
CancellationToken

Ein Token, das zum Abbrechen des Lesevorgangs verwendet werden kann.

Gibt zurück

ValueTask<TValue>

Eine TValue Darstellung des JSON-Werts.

Ausnahmen

Der JSON-Code ist ungültig.

-oder-

TValue ist nicht mit dem JSON kompatibel.

-oder-

Es gibt verbleibende Daten im Datenstrom.

Es gibt keine kompatiblen JsonConverter für TValue oder die serialisierbaren Member.

utf8Jsonist null.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Weitere Informationen finden Sie unter How to serialize and deserialize JSON.

Gilt für: