Freigeben über


JsonSerializer.SerializeAsync Methode

Definition

Überlädt

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

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den Stream.

SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den PipeWriter.

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

Konvertiert asynchron den Wert eines angegebenen Typs in UTF-8-codierten JSON-Text und schreibt ihn in den angegebenen Datenstrom.

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den Stream.

SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den PipeWriter.

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

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den PipeWriter.

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

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den PipeWriter.

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

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den PipeWriter.

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

Konvertiert asynchron einen Wert eines Typs, der durch einen generischen Typparameter angegeben wird, in UTF-8-codierten JSON-Text und schreibt ihn in einen Datenstrom.

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

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den Stream.

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

Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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

Parameter

utf8Json
Stream

Der UTF-8-Stream, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

inputType
Type

Der Typ des zu konvertierenden value.

context
JsonSerializerContext

Ein Metadatenanbieter für serialisierbare Typen.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

inputType ist nicht mit valuekompatibel.

utf8Json, inputTypeoder context ist null.

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

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 Serialize(Stream, Object, Type, JsonSerializerContext)ausgelösten Ausnahmen.

Gilt für:

SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)

Quelle:
JsonSerializer.Write.Pipe.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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.Task
Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

utf8Json
PipeWriter

Der UTF-8-PipeWriter, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

inputType
Type

Der Typ des zu konvertierenden value.

context
JsonSerializerContext

Ein Metadatenanbieter für serialisierbare Typen.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

inputType ist nicht mit valuekompatibel.

utf8Json, inputTypeoder context ist null.

Es gibt keine kompatiblen JsonConverter

für inputType oder deren serialisierbare Member.

Gilt für:

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

Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs

Konvertiert asynchron den Wert eines angegebenen Typs in UTF-8-codierten JSON-Text und schreibt ihn in den angegebenen Datenstrom.

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

Parameter

utf8Json
Stream

Der UTF-8-Datenstrom, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

inputType
Type

Der Typ des zu konvertierenden value.

options
JsonSerializerOptions

Optionen zum Steuern des Serialisierungsverhaltens.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

inputType ist nicht mit valuekompatibel.

utf8Json oder inputType ist null.

Es gibt keine kompatiblen JsonConverter für inputType 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 Serialize(Stream, Object, Type, JsonSerializerOptions)ausgelösten Ausnahmen.

Gilt für:

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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

Parameter

utf8Json
Stream

Der UTF-8-Stream, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

jsonTypeInfo
JsonTypeInfo

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

value stimmt nicht mit dem Typ der jsonTypeInfoüberein.

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

Gilt für:

SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)

Quelle:
JsonSerializer.Write.Pipe.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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.Task
Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

utf8Json
PipeWriter

Der UTF-8-PipeWriter, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

jsonTypeInfo
JsonTypeInfo

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

value stimmt nicht mit dem Typ der jsonTypeInfoüberein.

Gilt für:

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

Quelle:
JsonSerializer.Write.Pipe.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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.Task
Public Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

utf8Json
PipeWriter

Der UTF-8-PipeWriter, in den geschrieben werden soll.

value
Object

Der zu konvertierende Wert.

inputType
Type

Der Typ des zu konvertierenden value.

options
JsonSerializerOptions

Optionen zum Steuern des Konvertierungsverhaltens.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

inputType ist nicht mit valuekompatibel.

utf8Json oder inputType ist null.

Es gibt keine kompatiblen JsonConverter

für inputType oder deren serialisierbare Member.

Gilt für:

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

Quelle:
JsonSerializer.Write.Pipe.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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.Task
Public Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Typparameter

TValue

Der Typ des zu serialisierenden Werts.

Parameter

utf8Json
PipeWriter

Der UTF-8-PipeWriter, in den geschrieben werden soll.

value
TValue

Der zu konvertierende Wert.

options
JsonSerializerOptions

Optionen zum Steuern des Konvertierungsverhaltens.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

Es gibt keine kompatiblen JsonConverter

für TValue oder deren serialisierbare Member.

Gilt für:

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

Quelle:
JsonSerializer.Write.Pipe.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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.Task
Public Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As Task

Typparameter

TValue

Der Typ des zu serialisierenden Werts.

Parameter

utf8Json
PipeWriter

Der UTF-8-PipeWriter, in den geschrieben werden soll.

value
TValue

Der zu konvertierende Wert.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

Gilt für:

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

Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs

Konvertiert asynchron einen Wert eines Typs, der durch einen generischen Typparameter angegeben wird, in UTF-8-codierten JSON-Text und schreibt ihn in einen Datenstrom.

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

Typparameter

TValue

Der Typ des zu serialisierenden Werts.

Parameter

utf8Json
Stream

Der UTF-8-Datenstrom, in den geschrieben werden soll.

value
TValue

Der zu konvertierende Wert.

options
JsonSerializerOptions

Optionen zum Steuern des Serialisierungsverhaltens.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

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.

Hinweise

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

Gilt für:

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

Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs
Quelle:
JsonSerializer.Write.Stream.cs

Konvertiert den bereitgestellten Wert in UTF-8-codierten JSON-Text und schreibt ihn in den 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

Typparameter

TValue

Der Typ des zu serialisierenden Werts.

Parameter

utf8Json
Stream

Der UTF-8-Stream, in den geschrieben werden soll.

value
TValue

Der zu konvertierende Wert.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadaten zum zu konvertierenden Typ.

cancellationToken
CancellationToken

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

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

utf8Json ist null.

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: