JsonSerializer.SerializeAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| SerializeAsync(Stream, Object, Type, JsonSerializerContext, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
| SerializeAsync(Stream, Object, JsonTypeInfo, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
| SerializeAsync(Stream, Object, Type, JsonSerializerOptions, CancellationToken) |
Асинхронно преобразует значение указанного типа в текст JSON в кодировке UTF-8 и записывает его в указанный поток. |
| SerializeAsync<TValue>(Stream, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Преобразует предоставленное значение в текст JSON в кодировке UTF-8 и записывает его в Stream. |
| SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) |
Асинхронно преобразует значение типа, заданного параметром универсального типа, в текст JSON в кодировке UTF-8 и записывает его в поток. |
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 или context равно null.
Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Serialize(Stream, Object, Type, JsonSerializerContext).
Применяется к
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(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 или inputType имеет значение null.
Совместимые объекты JsonConverter для inputType или его сериализуемых членов отсутствуют.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Дополнительные сведения см. в разделе Сериализация и десериализация JSON.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Serialize(Stream, Object, Type, JsonSerializerOptions).
Применяется к
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 или его сериализуемых членов отсутствуют.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Применяется к
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.
Применяется к
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по