Compartilhar via


JsonSerializer.DeserializeAsync Método

Definição

Sobrecargas

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

Lê o texto codificado em UTF-8 que representa um único valor JSON em uma instância especificada pelo jsonTypeInfo. O Fluxo será lido até a conclusão.

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

Lê de forma assíncrona o texto codificado em UTF-8 que representa um único valor JSON em uma instância de um tipo especificado. O fluxo será lido até a conclusão.

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

Lê o texto codificado em UTF-8 que representa um único valor JSON em um returnType. O Fluxo será lido até a conclusão.

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

Lê o texto codificado em UTF-8 que representa um único valor JSON em um TValue. O Fluxo será lido até a conclusão.

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

Lê de forma assíncrona o texto codificado em UTF-8 que representa um único valor JSON em uma instância de um tipo especificado por um parâmetro de tipo genérico. O fluxo será lido até a conclusão.

DeserializeAsync(Stream, JsonTypeInfo, CancellationToken)

Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs

Lê o texto codificado em UTF-8 que representa um único valor JSON em uma instância especificada pelo jsonTypeInfo. O Fluxo será lido até a conclusão.

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)

Parâmetros

utf8Json
Stream

Dados JSON a serem analisados.

jsonTypeInfo
JsonTypeInfo

Metadados sobre o tipo a ser convertido.

cancellationToken
CancellationToken

O CancellationToken que pode ser usado para cancelar a operação de leitura.

Retornos

Uma representação jsonTypeInfo do valor JSON.

Exceções

utf8Json ou jsonTypeInfo é null.

O JSON é inválido ou quando há dados restantes no Fluxo.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Aplica-se a

DeserializeAsync(Stream, Type, JsonSerializerOptions, CancellationToken)

Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs

Lê de forma assíncrona o texto codificado em UTF-8 que representa um único valor JSON em uma instância de um tipo especificado. O fluxo será lido até a conclusão.

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)

Parâmetros

utf8Json
Stream

Os dados JSON a serem analisados.

returnType
Type

O tipo do objeto para o qual converter e retornar.

options
JsonSerializerOptions

Opções para controlar o comportamento durante a leitura.

cancellationToken
CancellationToken

Um token de cancelamento que pode ser usado para cancelar a operação de leitura.

Retornos

Uma representação returnType do valor JSON.

Exceções

utf8Json ou returnType é null.

O JSON é inválido.

-ou-

TValue não é compatível com o JSON.

-ou-

Há dados restantes no fluxo.

Não há JsonConverter compatíveis para returnType ou seus membros serializáveis.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Para obter mais informações, consulte Como serializar e desserializarJSON.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Deserialize(Stream, Type, JsonSerializerOptions).

Aplica-se a

DeserializeAsync(Stream, Type, JsonSerializerContext, CancellationToken)

Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs

Lê o texto codificado em UTF-8 que representa um único valor JSON em um returnType. O Fluxo será lido até a conclusão.

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)

Parâmetros

utf8Json
Stream

Dados JSON a serem analisados.

returnType
Type

O tipo do objeto para o qual converter e retornar.

context
JsonSerializerContext

Um provedor de metadados para tipos serializáveis.

cancellationToken
CancellationToken

O CancellationToken que pode ser usado para cancelar a operação de leitura.

Retornos

Uma representação returnType do valor JSON.

Exceções

utf8Json, returnTypeou context é null.

O JSON é inválido, o returnType não é compatível com o JSON ou os dados restantes no Fluxo.

Não há JsonConverter compatíveis para returnType ou seus membros serializáveis.

O método GetTypeInfo(Type) no context fornecido não retornou um JsonTypeInfo compatível para returnType.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Deserialize(Stream, Type, JsonSerializerContext).

Aplica-se a

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

Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs

Lê o texto codificado em UTF-8 que representa um único valor JSON em um TValue. O Fluxo será lido até a conclusão.

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)

Parâmetros de tipo

TValue

O tipo em que desserializar o valor JSON.

Parâmetros

utf8Json
Stream

Dados JSON a serem analisados.

jsonTypeInfo
JsonTypeInfo<TValue>

Metadados sobre o tipo a ser convertido.

cancellationToken
CancellationToken

O CancellationToken que pode ser usado para cancelar a operação de leitura.

Retornos

ValueTask<TValue>

Uma representação TValue do valor JSON.

Exceções

utf8Json ou jsonTypeInfo é null.

O JSON é inválido, TValue não é compatível com o JSON ou há dados restantes no Stream.

Não há JsonConverter compatíveis para TValue ou seus membros serializáveis.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Aplica-se a

DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken)

Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs
Origem:
JsonSerializer.Read.Stream.cs

Lê de forma assíncrona o texto codificado em UTF-8 que representa um único valor JSON em uma instância de um tipo especificado por um parâmetro de tipo genérico. O fluxo será lido até a conclusão.

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)

Parâmetros de tipo

TValue

O tipo de destino do valor JSON.

Parâmetros

utf8Json
Stream

Os dados JSON a serem analisados.

options
JsonSerializerOptions

Opções para controlar o comportamento durante a leitura.

cancellationToken
CancellationToken

Um token que pode ser usado para cancelar a operação de leitura.

Retornos

ValueTask<TValue>

Uma representação TValue do valor JSON.

Exceções

O JSON é inválido.

-ou-

TValue não é compatível com o JSON.

-ou-

Há dados restantes no fluxo.

Não há JsonConverter compatíveis para TValue ou seus membros serializáveis.

utf8Jsoné null.

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Para obter mais informações, consulte Como serializar e desserializarJSON.

Aplica-se a