JsonSerializer.SerializeAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в PipeWriter. |
| SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Асинхронно преобразует значение указанного типа в текст JSON в кодировке UTF-8 и записывает его в указанный поток. |
| SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
| SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в PipeWriter. |
| SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в PipeWriter. |
| SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в PipeWriter. |
| SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Асинхронно преобразует значение типа, указанного параметром универсального типа, в текст JSON в кодировке UTF-8 и записывает его в поток. |
| SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken)
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- value
- Object
Значение для преобразования.
- inputType
- Type
Тип преобразованного value.
- context
- JsonSerializerContext
Поставщик метаданных для сериализуемых типов.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
inputType несовместим с value.
utf8Json, inputTypeили contextnull.
Несовместимые JsonConverter для inputType или его сериализуемых элементов.
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
Комментарии
Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых Serialize(Stream, Object, Type, JsonSerializerContext).
Применяется к
SerializeAsync(PipeWriter, Object, Type, JsonSerializerContext, CancellationToken)
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- utf8Json
- PipeWriter
PipeWriter UTF-8 для записи.
- value
- Object
Значение для преобразования.
- inputType
- Type
Тип преобразованного value.
- context
- JsonSerializerContext
Поставщик метаданных для сериализуемых типов.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
inputType несовместим с value.
utf8Json, inputTypeили contextnull.
Применяется к
SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken)
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
Асинхронно преобразует значение указанного типа в текст JSON в кодировке UTF-8 и записывает его в указанный поток.
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.TaskPublic Shared Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- utf8Json
- Stream
Поток UTF-8 для записи.
- value
- Object
Значение для преобразования.
- inputType
- Type
Тип преобразованного value.
- options
- JsonSerializerOptions
Параметры управления поведением сериализации.
- cancellationToken
- CancellationToken
Маркер, который может использоваться для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
inputType несовместим с value.
utf8Json или inputTypenull.
Несовместимые JsonConverter для inputType или его сериализуемых элементов.
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
Комментарии
Дополнительные сведения см. в разделе Сериализация и десериализация JSON.
Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых Serialize(Stream, Object, Type, JsonSerializerOptions).
Применяется к
SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken)
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync (utf8Json As Stream, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- value
- Object
Значение для преобразования.
- jsonTypeInfo
- JsonTypeInfo
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
value не соответствует типу jsonTypeInfo.
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
Применяется к
SerializeAsync(PipeWriter, Object, JsonTypeInfo, CancellationToken)
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- utf8Json
- PipeWriter
PipeWriter UTF-8 для записи.
- value
- Object
Значение для преобразования.
- jsonTypeInfo
- JsonTypeInfo
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
value не соответствует типу jsonTypeInfo.
Применяется к
SerializeAsync(PipeWriter, Object, Type, JsonSerializerOptions, CancellationToken)
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync (utf8Json As PipeWriter, value As Object, inputType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры
- utf8Json
- PipeWriter
PipeWriter UTF-8 для записи.
- value
- Object
Значение для преобразования.
- inputType
- Type
Тип преобразованного value.
- options
- JsonSerializerOptions
Параметры для управления поведением преобразования.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
inputType несовместим с value.
utf8Json или inputTypenull.
Применяется к
SerializeAsync<TValue>(PipeWriter, TValue, JsonSerializerOptions, CancellationToken)
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры типа
- TValue
Тип сериализации значения.
Параметры
- utf8Json
- PipeWriter
PipeWriter UTF-8 для записи.
- value
- TValue
Значение для преобразования.
- options
- JsonSerializerOptions
Параметры для управления поведением преобразования.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
Применяется к
SerializeAsync<TValue>(PipeWriter, TValue, JsonTypeInfo<TValue>, CancellationToken)
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As PipeWriter, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры типа
- TValue
Тип сериализации значения.
Параметры
- utf8Json
- PipeWriter
PipeWriter UTF-8 для записи.
- value
- TValue
Значение для преобразования.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
Применяется к
SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken)
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
Асинхронно преобразует значение типа, указанного параметром универсального типа, в текст JSON в кодировке UTF-8 и записывает его в поток.
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.TaskPublic Shared Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskPublic Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры типа
- TValue
Тип сериализации значения.
Параметры
- utf8Json
- Stream
Поток UTF-8 для записи.
- value
- TValue
Значение для преобразования.
- options
- JsonSerializerOptions
Параметры управления поведением сериализации.
- cancellationToken
- CancellationToken
Маркер, который может использоваться для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
Несовместимые JsonConverter для TValue или его сериализуемых элементов.
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
Комментарии
Дополнительные сведения см. в разделе Сериализация и десериализация JSON.
Применяется к
SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken)
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
- Исходный код:
- JsonSerializer.Write.Stream.cs
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в 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.TaskPublic Function SerializeAsync(Of TValue) (utf8Json As Stream, value As TValue, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As TaskПараметры типа
- TValue
Тип сериализации значения.
Параметры
- value
- TValue
Значение для преобразования.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
CancellationToken, которые можно использовать для отмены операции записи.
Возвращаемое значение
Задача, представляющая асинхронную операцию записи.
Исключения
utf8Json
null.
Несовместимые JsonConverter для TValue или его сериализуемых элементов.
Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.
