ValueTask<TResult> ValueTask<TResult> ValueTask<TResult> ValueTask<TResult> Struct

Definição

Fornece um tipo de valor que encapsula um Task<TResult> e um TResult. Somente um de cada é usado.Provides a value type that wraps a Task<TResult> and a TResult, only one of which is used.

generic <typename TResult>
public value class ValueTask : IEquatable<System::Threading::Tasks::ValueTask<TResult>>
public struct ValueTask<TResult> : IEquatable<System.Threading.Tasks.ValueTask<TResult>>
type ValueTask<'Result> = struct
Public Structure ValueTask(Of TResult)
Implements IEquatable(Of ValueTask(Of TResult))

Parâmetros de tipo

TResult

O resultado.The result.

Herança
ValueTask<TResult>ValueTask<TResult>ValueTask<TResult>ValueTask<TResult>
Implementações
IEquatable<ValueTask<TResult>>

Comentários

Um ValueTask<TResult> instância pode ser colocada em espera ou convertida em um Task<TResult> usando AsTask.A ValueTask<TResult> instance may either be awaited or converted to a Task<TResult> using AsTask. Um ValueTask<TResult> instância só pode ser esperada uma vez e consumidores não podem chamar GetAwaiter() até que a instância foi concluída.A ValueTask<TResult> instance may only be awaited once, and consumers may not call GetAwaiter() until the instance has completed. Se essas limitações são inaceitáveis, converta a ValueTask<TResult> para um Task<TResult> chamando AsTask.If these limitations are unacceptable, convert the ValueTask<TResult> to a Task<TResult> by calling AsTask.

As seguintes operações nunca devem ser executadas em um ValueTask<TResult> instância:The following operations should never be performed on a ValueTask<TResult> instance:

  • Aguardando a instância várias vezes.Awaiting the instance multiple times.
  • Chamar AsTask várias vezes.Calling AsTask multiple times.
  • Usando o .Result ou .GetAwaiter().GetResult() quando a operação ainda não concluiu ou usá-los várias vezes.Using .Result or .GetAwaiter().GetResult() when the operation hasn't yet completed, or using them multiple times.
  • Usando mais de uma dessas técnicas para consumir a instância.Using more than one of these techniques to consume the instance.

Se você executar qualquer uma das opções acima, os resultados são indefinidos.If you do any of the above, the results are undefined.

Um método pode retornar uma instância desse tipo de valor quando ele é provável que o resultado de sua operação estarão disponível forma síncrona, e quando é esperado para ser invocada com tanta frequência que o custo de alocar um novo Task<TResult> para cada chamada será proibitiva.A method may return an instance of this value type when it's likely that the result of its operation will be available synchronously, and when it's expected to be invoked so frequently that the cost of allocating a new Task<TResult> for each call will be prohibitive.

Há vantagens e desvantagens para usando um ValueTask<TResult> em vez de um Task<TResult>.There are tradeoffs to using a ValueTask<TResult> instead of a Task<TResult>. Por exemplo, embora uma ValueTask<TResult> pode ajudar a evitar uma alocação no caso em que o resultado com êxito está disponível sincronicamente, ele também contém dois campos, enquanto um Task<TResult> como uma referência de tipo é um único campo.For example, while a ValueTask<TResult> can help avoid an allocation in the case where the successful result is available synchronously, it also contains two fields, whereas a Task<TResult> as a reference type is a single field. Isso significa que uma chamada de método retorna dois campos que vale a pena de dados em vez de um, que é mais dados a serem copiados.This means that a method call returns two fields worth of data instead of one, which is more data to copy. Também significa que se um método que retorna um ValueTask<TResult> é aguardada dentro de um método assíncrono, a máquina de estado para o método assíncrono será maior, porque ele deve armazenar uma estrutura que contém dois campos em vez de uma única referência.It also means, that if a method that returns a ValueTask<TResult> is awaited within an async method, the state machine for that async method will be larger, because it must store a struct containing two fields instead of a single reference.

Para usos diferentes consumindo o resultado de uma operação assíncrona usando await, ValueTask<TResult> pode levar a um modelo de programação mais complicado que requer mais alocações.For uses other than consuming the result of an asynchronous operation using await, ValueTask<TResult> can lead to a more convoluted programming model that requires more allocations. Por exemplo, considere um método que pode retornar um Task<TResult> com uma tarefa em cache como um resultado comum ou um ValueTask<TResult>.For example, consider a method that could return either a Task<TResult> with a cached task as a common result or a ValueTask<TResult>. Se o consumidor do resultado deseja usá-la como uma Task<TResult> em um método como WhenAll ou WhenAny, o ValueTask<TResult> primeiro deve ser convertido em um Task<TResult> usando AsTask, à esquerda para uma alocação que poderia ter sido evitada se um armazenados em cache Task<TResult> tivesse sido usada em primeiro lugar.If the consumer of the result wants to use it as a Task<TResult> in a method like WhenAll or WhenAny, the ValueTask<TResult> must first be converted to a Task<TResult> using AsTask, leading to an allocation that would have been avoided if a cached Task<TResult> had been used in the first place.

Como tal, a opção padrão para qualquer método assíncrono deve ser para retornar um Task ou Task<TResult>.As such, the default choice for any asynchronous method should be to return a Task or Task<TResult>. Somente se a análise de desempenho prove que vale a pena deve uma ValueTask<TResult> ser usada em vez de um Task<TResult>.Only if performance analysis proves it worthwhile should a ValueTask<TResult> be used instead of a Task<TResult>. A versão não genérica de ValueTask não é recomendado na maioria dos cenários.The non generic version of ValueTask is not recommended for most scenarios. O CompletedTask propriedade deve ser usada para devolver um singleton concluído com êxito no caso em que um método retornando um Task for concluída de forma síncrona e com êxito.The CompletedTask property should be used to hand back a successfully completed singleton in the case where a method returning a Task completes synchronously and successfully.

Observação

O uso do ValueTask<TResult> há suporte para tipo começando com C# 7.0 e não é suportado por qualquer versão do Visual Basic.The use of the ValueTask<TResult> type is supported starting with C# 7.0, and is not supported by any version of Visual Basic.

Construtores

ValueTask<TResult>(Task<TResult>) ValueTask<TResult>(Task<TResult>) ValueTask<TResult>(Task<TResult>) ValueTask<TResult>(Task<TResult>)

Inicializa uma nova instância da classe ValueTask<TResult> usando a tarefa fornecida que representa a operação.Initializes a new instance of the ValueTask<TResult> class using the supplied task that represents the operation.

ValueTask<TResult>(TResult) ValueTask<TResult>(TResult) ValueTask<TResult>(TResult) ValueTask<TResult>(TResult)

Inicializa uma nova instância da classe ValueTask<TResult> usando o resultado fornecido de uma operação bem-sucedida.Initializes a new instance of the ValueTask<TResult> class using the supplied result of a successful operation.

ValueTask<TResult>(IValueTaskSource<TResult>, Int16) ValueTask<TResult>(IValueTaskSource<TResult>, Int16) ValueTask<TResult>(IValueTaskSource<TResult>, Int16) ValueTask<TResult>(IValueTaskSource<TResult>, Int16)

Propriedades

IsCanceled IsCanceled IsCanceled IsCanceled

Obtém um valor que indica se este objeto representa uma operação cancelada.Gets a value that indicates whether this object represents a canceled operation.

IsCompleted IsCompleted IsCompleted IsCompleted

Obtém um valor que indica se este objeto representa uma operação concluída.Gets a value that indicates whether this object represents a completed operation.

IsCompletedSuccessfully IsCompletedSuccessfully IsCompletedSuccessfully IsCompletedSuccessfully

Obtém um valor que indica se este objeto representa uma operação concluída com êxito.Gets a value that indicates whether this object represents a successfully completed operation.

IsFaulted IsFaulted IsFaulted IsFaulted

Obtém um valor que indica se este objeto representa uma operação com falha.Gets a value that indicates whether this object represents a failed operation.

Result Result Result Result

Obtém o resultado.Gets the result.

Métodos

AsTask() AsTask() AsTask() AsTask()

Recupera um objeto Task<TResult> que representa este ValueTask<TResult>.Retrieves a Task<TResult> object that represents this ValueTask<TResult>.

ConfigureAwait(Boolean) ConfigureAwait(Boolean) ConfigureAwait(Boolean) ConfigureAwait(Boolean)

Configura um awaiter para esse valor.Configures an awaiter for this value.

CreateAsyncMethodBuilder() CreateAsyncMethodBuilder() CreateAsyncMethodBuilder() CreateAsyncMethodBuilder()

Cria um construtor de método para ser usado com um método assíncrono.Creates a method builder for use with an async method.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

Equals(ValueTask<TResult>) Equals(ValueTask<TResult>) Equals(ValueTask<TResult>) Equals(ValueTask<TResult>)

Determina se o objeto ValueTask<TResult> especificado é igual ao objeto ValueTask<TResult> atual.Determines whether the specified ValueTask<TResult> object is equal to the current ValueTask<TResult> object.

GetAwaiter() GetAwaiter() GetAwaiter() GetAwaiter()

Cria um awaiter para esse valor.Creates an awaiter for this value.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

Preserve() Preserve() Preserve() Preserve()
ToString() ToString() ToString() ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

Operadores

Equality(ValueTask<TResult>, ValueTask<TResult>) Equality(ValueTask<TResult>, ValueTask<TResult>) Equality(ValueTask<TResult>, ValueTask<TResult>) Equality(ValueTask<TResult>, ValueTask<TResult>)

Compara dois valores quanto à igualdade.Compares two values for equality.

Inequality(ValueTask<TResult>, ValueTask<TResult>) Inequality(ValueTask<TResult>, ValueTask<TResult>) Inequality(ValueTask<TResult>, ValueTask<TResult>) Inequality(ValueTask<TResult>, ValueTask<TResult>)

Determina se dois valores ValueTask<TResult> são diferentes.Determines whether two ValueTask<TResult> values are unequal.

Aplica-se a