JsonSerializer.DeserializeAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken) |
Считывает текст в кодировке UTF-8, представляющий одно значение JSON в . |
| DeserializeAsync(Stream, JsonTypeInfo, CancellationToken) |
Считывает текст в кодировке UTF-8, представляющий одно значение JSON, в экземпляр, указанный в |
| DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken) |
Асинхронное чтение текста в кодировке UTF-8, представляющего одно значение JSON, в экземпляр указанного типа. Поток считывается до завершения. |
| DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken) |
Считывает текст в кодировке UTF-8, представляющий одно значение JSON в . |
| DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken) |
Асинхронное чтение текста в кодировке UTF-8, представляющего одно значение JSON, в экземпляр типа, заданного параметром универсального типа. Поток считывается до завершения. |
DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
Считывает текст в кодировке UTF-8, представляющий одно значение JSON в .returnType
Поток будет считан до завершения.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.Serialization.JsonSerializerContext context, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.Serialization.JsonSerializerContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, context As JsonSerializerContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)Параметры
- utf8Json
- Stream
Данные JSON для анализа.
- returnType
- Type
Тип объекта для преобразования и возврата.
- context
- JsonSerializerContext
Поставщик метаданных для сериализуемых типов.
- cancellationToken
- CancellationToken
Объект CancellationToken , который можно использовать для отмены операции чтения.
Возвращаемое значение
Представление returnType данного значения JSON.
Исключения
Значение параметра utf8Json, returnType или context равно null.
Json недопустим returnType , несовместим с JSON или в потоке остались данные.
Совместимые объекты JsonConverter для returnType или его сериализуемых членов отсутствуют.
Метод GetTypeInfo(Type) в предоставленном context не вернул совместимый JsonTypeInfo для returnType.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Deserialize(Stream, Type, JsonSerializerContext).
Применяется к
DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
Считывает текст в кодировке UTF-8, представляющий одно значение JSON, в экземпляр, указанный в jsonTypeInfo.
Поток будет считан до завершения.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>Public Function DeserializeAsync (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)Параметры
- utf8Json
- Stream
Данные JSON для анализа.
- jsonTypeInfo
- JsonTypeInfo
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
Объект CancellationToken , который можно использовать для отмены операции чтения.
Возвращаемое значение
Представление jsonTypeInfo данного значения JSON.
Исключения
Параметр utf8Json или jsonTypeInfo имеет значение null.
Json недопустим или при наличии оставшихся данных в потоке.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Применяется к
DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
Асинхронное чтение текста в кодировке UTF-8, представляющего одно значение JSON, в экземпляр указанного типа. Поток считывается до завершения.
public static System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.ValueTask<object> DeserializeAsync (System.IO.Stream utf8Json, Type returnType, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsync : System.IO.Stream * Type * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>Public Shared Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)Public Function DeserializeAsync (utf8Json As Stream, returnType As Type, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Object)Параметры
- utf8Json
- Stream
Анализируемые данные JSON.
- returnType
- Type
Тип объекта для преобразования и возврата.
- options
- JsonSerializerOptions
Параметры для управления поведением во время чтения.
- cancellationToken
- CancellationToken
Токен отмены, который может использоваться для отмены операции чтения.
Возвращаемое значение
Представление returnType данного значения JSON.
Исключения
Параметр utf8Json или returnType имеет значение null.
Совместимые объекты JsonConverter для returnType или его сериализуемых членов отсутствуют.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Дополнительные сведения см. в разделе Сериализация и десериализация JSON.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Deserialize(Stream, Type, JsonSerializerOptions).
Применяется к
DeserializeAsync<TValue>(Stream, JsonTypeInfo<TValue>, CancellationToken)
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
Считывает текст в кодировке UTF-8, представляющий одно значение JSON в .TValue
Поток будет считан до завершения.
public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.Serialization.Metadata.JsonTypeInfo<TValue> jsonTypeInfo, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsync : System.IO.Stream * System.Text.Json.Serialization.Metadata.JsonTypeInfo<'Value> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, jsonTypeInfo As JsonTypeInfo(Of TValue), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)Параметры типа
- TValue
Тип для десериализации значения JSON.
Параметры
- utf8Json
- Stream
Данные JSON для анализа.
- jsonTypeInfo
- JsonTypeInfo<TValue>
Метаданные о преобразуемом типе.
- cancellationToken
- CancellationToken
Объект , CancellationToken который может использоваться для отмены операции чтения.
Возвращаемое значение
Представление TValue данного значения JSON.
Исключения
Параметр utf8Json или jsonTypeInfo имеет значение null.
Json является недопустимым, TValue несовместим с JSON или в потоке есть оставшиеся данные.
Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Применяется к
DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
- Исходный код:
- JsonSerializer.Read.Stream.cs
Асинхронное чтение текста в кодировке UTF-8, представляющего одно значение JSON, в экземпляр типа, заданного параметром универсального типа. Поток считывается до завершения.
public static System.Threading.Tasks.ValueTask<TValue?> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions? options = default, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.ValueTask<TValue> DeserializeAsync<TValue> (System.IO.Stream utf8Json, System.Text.Json.JsonSerializerOptions options = default, System.Threading.CancellationToken cancellationToken = default);static member DeserializeAsync : System.IO.Stream * System.Text.Json.JsonSerializerOptions * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'Value>Public Shared Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)Public Function DeserializeAsync(Of TValue) (utf8Json As Stream, Optional options As JsonSerializerOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TValue)Параметры типа
- TValue
Целевой тип значения JSON.
Параметры
- utf8Json
- Stream
Анализируемые данные JSON.
- options
- JsonSerializerOptions
Параметры для управления поведением во время чтения.
- cancellationToken
- CancellationToken
Токен, который можно использовать для отмены операции чтения.
Возвращаемое значение
Представление TValue данного значения JSON.
Исключения
Совместимые объекты JsonConverter для TValue или его сериализуемых членов отсутствуют.
utf8Json имеет значение null.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Дополнительные сведения см. в разделе Сериализация и десериализация JSON.
Применяется к
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по