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

Definición

Proporciona un tipo de valor que encapsula un Task<TResult> y un TResult(solo se usa uno de ellos).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

Resultado.The result.

Herencia
ValueTask<TResult>ValueTask<TResult>ValueTask<TResult>ValueTask<TResult>
Implementaciones
IEquatable<ValueTask<TResult>>

Comentarios

Un ValueTask<TResult> instancia puede que sea "awaited" o convertir a un Task<TResult> mediante AsTask.A ValueTask<TResult> instance may either be awaited or converted to a Task<TResult> using AsTask. Un ValueTask<TResult> instancia solo se puede esperar una vez y no pueden llamar los consumidores GetAwaiter() hasta que se ha completado la instancia.A ValueTask<TResult> instance may only be awaited once, and consumers may not call GetAwaiter() until the instance has completed. Si estas limitaciones son inaceptables, convierta el ValueTask<TResult> a un Task<TResult> mediante una llamada a AsTask.If these limitations are unacceptable, convert the ValueTask<TResult> to a Task<TResult> by calling AsTask.

Las siguientes operaciones no deben realizarse nunca en un ValueTask<TResult> instancia:The following operations should never be performed on a ValueTask<TResult> instance:

  • En espera de la instancia varias veces.Awaiting the instance multiple times.
  • Una llamada a AsTask varias veces.Calling AsTask multiple times.
  • Uso de .Result o .GetAwaiter().GetResult() cuando todavía no ha completado la operación o usarlos varias veces.Using .Result or .GetAwaiter().GetResult() when the operation hasn't yet completed, or using them multiple times.
  • Uso de más de una de estas técnicas para consumir la instancia.Using more than one of these techniques to consume the instance.

Si lo hace todo lo anterior, los resultados son indefinidos.If you do any of the above, the results are undefined.

Un método puede devolver una instancia de este tipo de valor cuando es probable que el resultado de su operación estará disponible en forma sincrónica, y cuando se espera que se puede invoca con tanta frecuencia que el costo de asignar un nuevo Task<TResult> para cada llamada será prohibitivo.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.

Existen ventajas e inconvenientes al uso de un ValueTask<TResult> en lugar de un Task<TResult>.There are tradeoffs to using a ValueTask<TResult> instead of a Task<TResult>. Por ejemplo, mientras un ValueTask<TResult> puede ayudar a evitar una asignación en el caso donde el resultado correcto está disponible sincrónicamente, también contiene dos campos, mientras que un Task<TResult> como una referencia de tipo es un campo único.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. Esto significa que una llamada al método devuelve dos campos que vale la pena de datos en lugar de uno, que es más datos para copiar.This means that a method call returns two fields worth of data instead of one, which is more data to copy. También significa, que si un método que devuelva un ValueTask<TResult> es "awaited" dentro de un método asincrónico, la máquina de Estados para dicho método asincrónico serán más grande, ya que debe almacenar una estructura que contiene dos campos en lugar de una única referencia.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 distintos consumiendo el resultado de una operación asincrónica mediante await, ValueTask<TResult> puede dar lugar a un modelo de programación más complejo que requiere más asignaciones.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 ejemplo, considere la posibilidad de un método que podría devolver un Task<TResult> con una tarea almacenada en caché como un resultado común o un 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>. Si el consumidor del resultado desea usarla como un Task<TResult> en un método como WhenAll o WhenAny, el ValueTask<TResult> debe convertirse primero a un Task<TResult> mediante AsTask, provocando una asignación que podrían haberse evitada si un almacenado en caché Task<TResult> hubiera usado en primer 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.

Por lo tanto, la opción predeterminada para cualquier método asincrónico debe devolver un Task o Task<TResult>.As such, the default choice for any asynchronous method should be to return a Task or Task<TResult>. Solo si el análisis de rendimiento demuestre que valga la pena debe un ValueTask<TResult> usarse en lugar de un Task<TResult>.Only if performance analysis proves it worthwhile should a ValueTask<TResult> be used instead of a Task<TResult>. La versión no genérica de ValueTask no se recomienda para la mayoría de los escenarios.The non generic version of ValueTask is not recommended for most scenarios. El CompletedTask propiedad se debe usar para entregar un singleton se completó correctamente en el caso donde un método que devuelve un Task finaliza de forma sincrónica y correctamente.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.

Nota

El uso de la ValueTask<TResult> tipo se admite a partir de C# 7.0 y no es compatible con cualquier versión de 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.

Constructores

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

Inicializa una nueva instancia de la clase ValueTask<TResult> usando la tarea suministrada que representa la operación.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 una nueva instancia de la clase ValueTask<TResult> usando el resultado suministrado de una operación realizada correctamente.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)

Propiedades

IsCanceled IsCanceled IsCanceled IsCanceled

Obtiene un valor que indica si este objeto representa una operación cancelada.Gets a value that indicates whether this object represents a canceled operation.

IsCompleted IsCompleted IsCompleted IsCompleted

Obtiene un valor que indica si este objeto representa una operación completada.Gets a value that indicates whether this object represents a completed operation.

IsCompletedSuccessfully IsCompletedSuccessfully IsCompletedSuccessfully IsCompletedSuccessfully

Obtiene un valor que indica si este objeto representa una operación completada correctamente.Gets a value that indicates whether this object represents a successfully completed operation.

IsFaulted IsFaulted IsFaulted IsFaulted

Obtiene un valor que indica si este objeto representa una operación con error.Gets a value that indicates whether this object represents a failed operation.

Result Result Result Result

Obtiene el resultado.Gets the result.

Métodos

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

Recupera un 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 un elemento que ejecuta await para este valor.Configures an awaiter for this value.

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

Crea un generador de método para usarlo con un método asincrónico.Creates a method builder for use with an async method.

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

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

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

Determina si el objeto ValueTask<TResult> especificado es igual al objeto ValueTask<TResult> actual.Determines whether the specified ValueTask<TResult> object is equal to the current ValueTask<TResult> object.

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

Crea un objeto que ejecuta await para este objeto awaitable.Creates an awaiter for this value.

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

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

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

Devuelve una cadena que representa el objeto actual.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 dos valores para determinar si son iguales.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 si dos valores ValueTask<TResult> son desiguales.Determines whether two ValueTask<TResult> values are unequal.

Se aplica a