Bagikan melalui

JsonSerializer.SerializeAsync Metode

  • Referensi

Definisi

Ruang nama:
System.Text.Json
Rakitan:
System.Text.Json.dll
Paket:
System.Text.Json v8.0.5
Paket:
System.Text.Json v9.0.0-rc.2.24473.5

Overload

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

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke Stream.
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke PipeWriter.
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)

Secara asinkron mengonversi nilai jenis tertentu menjadi teks JSON yang dikodekan UTF-8 dan menulisnya ke aliran yang ditentukan.
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke Stream.
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke PipeWriter.
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke PipeWriter.
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke PipeWriter.
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke PipeWriter.
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)

Secara asinkron mengonversi nilai jenis yang ditentukan oleh parameter jenis generik ke teks JSON yang dikodekan UTF-8 dan menulisnya ke aliran.
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke Stream.

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

Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

UTF-8 Stream untuk ditulis.

value
Object

Nilai yang akan dikonversi.

inputType
Type

Jenis value yang akan dikonversi.

context
JsonSerializerContext

Penyedia metadata untuk jenis yang dapat diserialisasikan.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentException

inputType tidak kompatibel dengan value.

ArgumentNullException

utf8Json, inputType, atau contextnull.

NotSupportedException

Tidak ada JsonConverter yang kompatibel untuk inputType atau anggotanya yang dapat diserialisasikan.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Metode ini disimpan dalam tugas yang mengembalikan semua pengecualian non-penggunaan yang dapat dilemparkan oleh rekan sinkron metode. Jika pengecualian disimpan ke dalam tugas yang dikembalikan, pengecualian tersebut akan dilemparkan saat tugas ditunggu. Pengecualian penggunaan, seperti ArgumentException, masih dilemparkan secara sinkron. Untuk pengecualian yang disimpan, lihat pengecualian yang dilemparkan oleh Serialize(Stream, Object, Type, JsonSerializerContext).

Berlaku untuk

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

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

UTF-8 PipeWriter untuk ditulis.

value
Object

Nilai yang akan dikonversi.

inputType
Type

Jenis value yang akan dikonversi.

context
JsonSerializerContext

Penyedia metadata untuk jenis yang dapat diserialisasikan.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentException

inputType tidak kompatibel dengan value.

ArgumentNullException

utf8Json, inputType, atau contextnull.

NotSupportedException

Tidak ada JsonConverter yang kompatibel

untuk inputType atau anggotanya yang dapat diserialisasikan.

Berlaku untuk

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

Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs

Secara asinkron mengonversi nilai jenis tertentu menjadi teks JSON yang dikodekan UTF-8 dan menulisnya ke aliran yang ditentukan.

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

Aliran UTF-8 untuk ditulis.

value
Object

Nilai yang akan dikonversi.

inputType
Type

Jenis value yang akan dikonversi.

options
JsonSerializerOptions

Opsi untuk mengontrol perilaku serialisasi.

cancellationToken
CancellationToken

Token yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentException

inputType tidak kompatibel dengan value.

ArgumentNullException

utf8Json atau inputTypenull.

NotSupportedException

Tidak ada JsonConverter yang kompatibel untuk inputType atau anggotanya yang dapat diserialisasikan.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Untuk informasi selengkapnya, lihat Cara membuat serialisasi dan mendeserialisasi JSON.

Metode ini disimpan dalam tugas yang mengembalikan semua pengecualian non-penggunaan yang dapat dilemparkan oleh rekan sinkron metode. Jika pengecualian disimpan ke dalam tugas yang dikembalikan, pengecualian tersebut akan dilemparkan saat tugas ditunggu. Pengecualian penggunaan, seperti ArgumentException, masih dilemparkan secara sinkron. Untuk pengecualian yang disimpan, lihat pengecualian yang dilemparkan oleh Serialize(Stream, Object, Type, JsonSerializerOptions).

Berlaku untuk

SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)

Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

UTF-8 Stream untuk ditulis.

value
Object

Nilai yang akan dikonversi.

jsonTypeInfo
JsonTypeInfo

Metadata tentang jenis yang akan dikonversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

InvalidCastException

value tidak cocok dengan jenis jsonTypeInfo.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Berlaku untuk

SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

UTF-8 PipeWriter untuk ditulis.

value
Object

Nilai yang akan dikonversi.

jsonTypeInfo
JsonTypeInfo

Metadata tentang jenis yang akan dikonversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

InvalidCastException

value tidak cocok dengan jenis jsonTypeInfo.

Berlaku untuk

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

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

UTF-8 PipeWriter untuk ditulis.

value
Object

Nilai yang akan dikonversi.

inputType
Type

Jenis value yang akan dikonversi.

options
JsonSerializerOptions

Opsi untuk mengontrol perilaku konversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentException

inputType tidak kompatibel dengan value.

ArgumentNullException

utf8Json atau inputTypenull.

NotSupportedException

Tidak ada JsonConverter yang kompatibel

untuk inputType atau anggotanya yang dapat diserialisasikan.

Berlaku untuk

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

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

Jenis parameter

TValue

Jenis nilai yang akan diserialisasikan.

Parameter

utf8Json
PipeWriter

UTF-8 PipeWriter untuk ditulis.

value
TValue

Nilai yang akan dikonversi.

options
JsonSerializerOptions

Opsi untuk mengontrol perilaku konversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

NotSupportedException

Tidak ada JsonConverter yang kompatibel

untuk TValue atau anggotanya yang dapat diserialisasikan.

Berlaku untuk

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

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

Jenis parameter

TValue

Jenis nilai yang akan diserialisasikan.

Parameter

utf8Json
PipeWriter

UTF-8 PipeWriter untuk ditulis.

value
TValue

Nilai yang akan dikonversi.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadata tentang jenis yang akan dikonversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

Berlaku untuk

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

Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs

Secara asinkron mengonversi nilai jenis yang ditentukan oleh parameter jenis generik ke teks JSON yang dikodekan UTF-8 dan menulisnya ke aliran.

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

Jenis parameter

TValue

Jenis nilai yang akan diserialisasikan.

Parameter

utf8Json
Stream

Aliran UTF-8 untuk ditulis.

value
TValue

Nilai yang akan dikonversi.

options
JsonSerializerOptions

Opsi untuk mengontrol perilaku serialisasi.

cancellationToken
CancellationToken

Token yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

NotSupportedException

Tidak ada JsonConverter yang kompatibel untuk TValue atau anggotanya yang dapat diserialisasikan.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Untuk informasi selengkapnya, lihat Cara membuat serialisasi dan mendeserialisasi JSON.

Berlaku untuk

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

Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs
Sumber:
JsonSerializer.Write.Stream.cs

Mengonversi nilai yang disediakan ke teks JSON yang dikodekan UTF-8 dan menulisnya ke 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

Jenis parameter

TValue

Jenis nilai yang akan diserialisasikan.

Parameter

utf8Json
Stream

UTF-8 Stream untuk ditulis.

value
TValue

Nilai yang akan dikonversi.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadata tentang jenis yang akan dikonversi.

cancellationToken
CancellationToken

CancellationToken yang dapat digunakan untuk membatalkan operasi tulis.

Mengembalikan

Task

Tugas yang mewakili operasi tulis asinkron.

Pengecualian

ArgumentNullException

utf8Json null.

NotSupportedException

Tidak ada JsonConverter yang kompatibel untuk TValue atau anggotanya yang dapat diserialisasikan.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Berlaku untuk