ValueTask<TResult> Структура

Определение

generic <typename TResult>
public value class ValueTask : IEquatable<System::Threading::Tasks::ValueTask<TResult>>

public readonly struct ValueTask<TResult> : IEquatable<System.Threading.Tasks.ValueTask<TResult>>

type ValueTask<'Result> = struct

Public Structure ValueTask(Of TResult)
Implements IEquatable(Of ValueTask(Of TResult))

Параметры типа

Наследование

Object

ValueType

ValueTask<TResult>

Реализации

IEquatable<ValueTask<TResult>>

Комментарии

ValueTask<TResult> Экземпляр может ожидаться или преобразован в Task<TResult> использованиеAsTask. Экземпляр ValueTask<TResult> может ожидаться только один раз, и потребители могут не читать Result до завершения экземпляра. Если эти ограничения неприемлемы, преобразуйте ValueTask<TResult> его в Task<TResult> вызов AsTask.

Следующие операции никогда не должны выполняться на экземпляре ValueTask<TResult> :

• Ожидание экземпляра несколько раз.
• Вызов AsTask несколько раз.
• Использование .Result или .GetAwaiter().GetResult() когда операция еще не завершена или использует их несколько раз.
• Использование нескольких из этих методов для использования экземпляра.

Если вы делаете любое из указанных выше действий, результаты не определены.

Метод может возвращать экземпляр этого типа значения, если скорее всего, результат его операции будет доступен синхронно, и когда ожидается, что стоимость выделения нового Task<TResult> для каждого вызова будет запрещена.

Существуют компромиссы для использования ValueTask<TResult> вместо Task<TResult>. Например, в то время как ValueTask<TResult> может помочь избежать выделения в случае, когда успешный результат доступен синхронно, он также содержит несколько полей, в то время Task<TResult> как в качестве ссылочного типа является одним полем. Это означает, что возврат ValueTask<TResult> из метода приводит к копированию дополнительных данных. Это также означает, что если метод, возвращающий объект ValueTask<TResult> , ожидается в асинхронном методе, то для этого асинхронного метода будет больше, так как он должен хранить структуру, содержащую несколько полей, а не одну ссылку.

Для использования, отличного от использования результата асинхронной операции с помощью await, может привести к более свертной модели программирования, ValueTask<TResult> требующей большего выделения. Например, рассмотрим метод, который может возвращать либо кэшированную задачу в качестве общего результата, либо Task<TResult> .ValueTask<TResult> Если потребитель результата хочет использовать его в качестве Task<TResult> метода, аналогичного WhenAll или WhenAny, ValueTask<TResult> сначала необходимо преобразовать в Task<TResult> использование AsTask, что привело бы к выделению, которое было бы избежать, если кэшированный Task<TResult> был использован в первую очередь.

Таким образом, выбор по умолчанию для любого асинхронного метода должен быть возвращен Task или Task<TResult>. Только если анализ производительности докажет, что он стоит ValueTask<TResult> использовать вместо .Task<TResult> Для большинства сценариев не рекомендуется использовать не универсальную версию ValueTask . Свойство CompletedTask должно использоваться для передачи успешно завершенного одноэлемента в случае, когда метод, возвращающий Task завершение синхронно и успешно.