JsonSerializer.SerializeAsync Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Przeciążenia
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream. |
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w PipeWriter. |
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Asynchronicznie konwertuje wartość określonego typu na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w określonym strumieniu. |
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream. |
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w PipeWriter. |
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w PipeWriter. |
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w PipeWriter. |
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w PipeWriter. |
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Asynchronicznie konwertuje wartość typu określonego przez ogólny parametr typu na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w strumieniu. |
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
- value
- Object
Wartość do przekonwertowania.
- inputType
- Type
Typ value
do konwersji.
- context
- JsonSerializerContext
Dostawca metadanych dla typów możliwych do serializacji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
inputType
nie jest zgodny z value
.
utf8Json
, inputType
lub context
jest null
.
Nie ma zgodnych JsonConverter dla inputType
ani jego składowych z możliwością serializacji.
Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.
Uwagi
Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłaszane przez Serialize(Stream, Object, Type, JsonSerializerContext).
Dotyczy
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
- Źródło:
- JsonSerializer.Write.Pipe.cs
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
Parametry
- utf8Json
- PipeWriter
PipeWriter do zapisu w formacie UTF-8.
- value
- Object
Wartość do przekonwertowania.
- inputType
- Type
Typ value
do konwersji.
- context
- JsonSerializerContext
Dostawca metadanych dla typów możliwych do serializacji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
inputType
nie jest zgodny z value
.
utf8Json
, inputType
lub context
jest null
.
Brak zgodnych JsonConverter
dla inputType
lub jego składowych z możliwością serializacji.
Dotyczy
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
Asynchronicznie konwertuje wartość określonego typu na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w określonym strumieniu.
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
Parametry
- utf8Json
- Stream
Strumień UTF-8 do zapisu.
- value
- Object
Wartość do przekonwertowania.
- inputType
- Type
Typ value
do konwersji.
- options
- JsonSerializerOptions
Opcje kontrolowania zachowania serializacji.
- cancellationToken
- CancellationToken
Token, który może służyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
inputType
nie jest zgodny z value
.
utf8Json
lub inputType
jest null
.
Nie ma zgodnych JsonConverter dla inputType
ani jego składowych z możliwością serializacji.
Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.
Uwagi
Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.
Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłaszane przez Serialize(Stream, Object, Type, JsonSerializerOptions).
Dotyczy
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
- value
- Object
Wartość do przekonwertowania.
- jsonTypeInfo
- JsonTypeInfo
Metadane dotyczące typu do konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
value
nie jest zgodny z typem jsonTypeInfo
.
Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.
Dotyczy
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
- Źródło:
- JsonSerializer.Write.Pipe.cs
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
Parametry
- utf8Json
- PipeWriter
PipeWriter do zapisu w formacie UTF-8.
- value
- Object
Wartość do przekonwertowania.
- jsonTypeInfo
- JsonTypeInfo
Metadane dotyczące typu do konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
value
nie jest zgodny z typem jsonTypeInfo
.
Dotyczy
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
- Źródło:
- JsonSerializer.Write.Pipe.cs
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
Parametry
- utf8Json
- PipeWriter
PipeWriter do zapisu w formacie UTF-8.
- value
- Object
Wartość do przekonwertowania.
- inputType
- Type
Typ value
do konwersji.
- options
- JsonSerializerOptions
Opcje kontrolowania zachowania konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
inputType
nie jest zgodny z value
.
utf8Json
lub inputType
jest null
.
Brak zgodnych JsonConverter
dla inputType
lub jego składowych z możliwością serializacji.
Dotyczy
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
- Źródło:
- JsonSerializer.Write.Pipe.cs
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
Parametry typu
- TValue
Typ wartości do serializacji.
Parametry
- utf8Json
- PipeWriter
PipeWriter do zapisu w formacie UTF-8.
- value
- TValue
Wartość do przekonwertowania.
- options
- JsonSerializerOptions
Opcje kontrolowania zachowania konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
Brak zgodnych JsonConverter
dla TValue
lub jego składowych z możliwością serializacji.
Dotyczy
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
- Źródło:
- JsonSerializer.Write.Pipe.cs
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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
Parametry typu
- TValue
Typ wartości do serializacji.
Parametry
- utf8Json
- PipeWriter
PipeWriter do zapisu w formacie UTF-8.
- value
- TValue
Wartość do przekonwertowania.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadane dotyczące typu do konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
Dotyczy
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
Asynchronicznie konwertuje wartość typu określonego przez ogólny parametr typu na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w strumieniu.
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
Parametry typu
- TValue
Typ wartości do serializacji.
Parametry
- utf8Json
- Stream
Strumień UTF-8 do zapisu.
- value
- TValue
Wartość do przekonwertowania.
- options
- JsonSerializerOptions
Opcje kontrolowania zachowania serializacji.
- cancellationToken
- CancellationToken
Token, który może służyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
Nie ma zgodnych JsonConverter dla TValue
ani jego składowych z możliwością serializacji.
Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.
Uwagi
Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.
Dotyczy
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
Konwertuje podaną wartość na tekst JSON zakodowany w formacie UTF-8 i zapisuje go w 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 wartości do serializacji.
Parametry
- value
- TValue
Wartość do przekonwertowania.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Metadane dotyczące typu do konwersji.
- cancellationToken
- CancellationToken
CancellationToken, których można użyć do anulowania operacji zapisu.
Zwraca
Zadanie reprezentujące operację zapisu asynchronicznego.
Wyjątki
utf8Json
jest null
.
Nie ma zgodnych JsonConverter dla TValue
ani jego składowych z możliwością serializacji.
Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.