Tools/dotnetcli/sdk/NuGetFallbackFolder/system.threading.tasks.extensions/4.3.0/lib/netstandard1.0/System.Threading.Tasks.Extensions.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>System.Threading.Tasks.Extensions</name>
   5     </assembly>
   6     <members>
   7         <member name="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute">
   8             <summary>
   9             Indicates the type of the async method builder that should be used by a language compiler to
  10             build the attributed type when used as the return type of an async method.
  11             </summary>
  12         </member>
  13         <member name="M:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.#ctor(System.Type)">
  14             <summary>Initializes the <see cref="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute"/>.</summary>
  15             <param name="builderType">The <see cref="T:System.Type"/> of the associated builder.</param>
  16         </member>
  17         <member name="P:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.BuilderType">
  18             <summary>Gets the <see cref="T:System.Type"/> of the associated builder.</summary>
  19         </member>
  20         <member name="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1">
  21             <summary>Represents a builder for asynchronous methods that returns a <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</summary>
  22             <typeparam name="TResult">The type of the result.</typeparam>
  23         </member>
  24         <member name="F:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1._methodBuilder">
  25             <summary>The <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1"/> to which most operations are delegated.</summary>
  26         </member>
  27         <member name="F:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1._result">
  28             <summary>The result for this builder, if it's completed before any awaits occur.</summary>
  29         </member>
  30         <member name="F:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1._haveResult">
  31             <summary>true if <see cref="F:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1._result"/> contains the synchronous result for the async method; otherwise, false.</summary>
  32         </member>
  33         <member name="F:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1._useBuilder">
  34             <summary>true if the builder should be used for setting/getting the result; otherwise, false.</summary>
  35         </member>
  36         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.Create">
  37             <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1"/> struct.</summary>
  38             <returns>The initialized instance.</returns>
  39         </member>
  40         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.Start``1(``0@)">
  41             <summary>Begins running the builder with the associated state machine.</summary>
  42             <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  43             <param name="stateMachine">The state machine instance, passed by reference.</param>
  44         </member>
  45         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.SetStateMachine(System.Runtime.CompilerServices.IAsyncStateMachine)">
  46             <summary>Associates the builder with the specified state machine.</summary>
  47             <param name="stateMachine">The state machine instance to associate with the builder.</param>
  48         </member>
  49         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.SetResult(`0)">
  50             <summary>Marks the task as successfully completed.</summary>
  51             <param name="result">The result to use to complete the task.</param>
  52         </member>
  53         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.SetException(System.Exception)">
  54             <summary>Marks the task as failed and binds the specified exception to the task.</summary>
  55             <param name="exception">The exception to bind to the task.</param>
  56         </member>
  57         <member name="P:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.Task">
  58             <summary>Gets the task for this builder.</summary>
  59         </member>
  60         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.AwaitOnCompleted``2(``0@,``1@)">
  61             <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  62             <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  63             <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  64             <param name="awaiter">the awaiter</param>
  65             <param name="stateMachine">The state machine.</param>
  66         </member>
  67         <member name="M:System.Runtime.CompilerServices.AsyncValueTaskMethodBuilder`1.AwaitUnsafeOnCompleted``2(``0@,``1@)">
  68             <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  69             <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  70             <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  71             <param name="awaiter">the awaiter</param>
  72             <param name="stateMachine">The state machine.</param>
  73         </member>
  74         <member name="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1">
  75             <summary>Provides an awaitable type that enables configured awaits on a <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</summary>
  76             <typeparam name="TResult">The type of the result produced.</typeparam>
  77         </member>
  78         <member name="F:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1._value">
  79             <summary>The wrapped <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</summary>
  80         </member>
  81         <member name="F:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1._continueOnCapturedContext">
  82             <summary>true to attempt to marshal the continuation back to the original context captured; otherwise, false.</summary>
  83         </member>
  84         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.#ctor(System.Threading.Tasks.ValueTask{`0},System.Boolean)">
  85             <summary>Initializes the awaitable.</summary>
  86             <param name="value">The wrapped <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</param>
  87             <param name="continueOnCapturedContext">
  88             true to attempt to marshal the continuation back to the original synchronization context captured; otherwise, false.
  89             </param>
  90         </member>
  91         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.GetAwaiter">
  92             <summary>Returns an awaiter for this <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> instance.</summary>
  93         </member>
  94         <member name="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter">
  95             <summary>Provides an awaiter for a <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/>.</summary>
  96         </member>
  97         <member name="F:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter._value">
  98             <summary>The value being awaited.</summary>
  99         </member>
 100         <member name="F:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter._continueOnCapturedContext">
 101             <summary>The value to pass to ConfigureAwait.</summary>
 102         </member>
 103         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter.#ctor(System.Threading.Tasks.ValueTask{`0},System.Boolean)">
 104             <summary>Initializes the awaiter.</summary>
 105             <param name="value">The value to be awaited.</param>
 106             <param name="continueOnCapturedContext">The value to pass to ConfigureAwait.</param>
 107         </member>
 108         <member name="P:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter.IsCompleted">
 109             <summary>Gets whether the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> has completed.</summary>
 110         </member>
 111         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter.GetResult">
 112             <summary>Gets the result of the ValueTask.</summary>
 113         </member>
 114         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter.OnCompleted(System.Action)">
 115             <summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/>.</summary>
 116         </member>
 117         <member name="M:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1.ConfiguredValueTaskAwaiter.UnsafeOnCompleted(System.Action)">
 118             <summary>Schedules the continuation action for the <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/>.</summary>
 119         </member>
 120         <member name="T:System.Runtime.CompilerServices.ValueTaskAwaiter`1">
 121             <summary>Provides an awaiter for a <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</summary>
 122         </member>
 123         <member name="F:System.Runtime.CompilerServices.ValueTaskAwaiter`1._value">
 124             <summary>The value being awaited.</summary>
 125         </member>
 126         <member name="M:System.Runtime.CompilerServices.ValueTaskAwaiter`1.#ctor(System.Threading.Tasks.ValueTask{`0})">
 127             <summary>Initializes the awaiter.</summary>
 128             <param name="value">The value to be awaited.</param>
 129         </member>
 130         <member name="P:System.Runtime.CompilerServices.ValueTaskAwaiter`1.IsCompleted">
 131             <summary>Gets whether the <see cref="T:System.Threading.Tasks.ValueTask`1"/> has completed.</summary>
 132         </member>
 133         <member name="M:System.Runtime.CompilerServices.ValueTaskAwaiter`1.GetResult">
 134             <summary>Gets the result of the ValueTask.</summary>
 135         </member>
 136         <member name="M:System.Runtime.CompilerServices.ValueTaskAwaiter`1.OnCompleted(System.Action)">
 137             <summary>Schedules the continuation action for this ValueTask.</summary>
 138         </member>
 139         <member name="M:System.Runtime.CompilerServices.ValueTaskAwaiter`1.UnsafeOnCompleted(System.Action)">
 140             <summary>Schedules the continuation action for this ValueTask.</summary>
 141         </member>
 142         <member name="T:System.Threading.Tasks.ValueTask`1">
 143             <summary>
 144             Provides a value type that wraps a <see cref="T:System.Threading.Tasks.Task`1"/> and a <typeparamref name="TResult"/>,
 145             only one of which is used.
 146             </summary>
 147             <typeparam name="TResult">The type of the result.</typeparam>
 148             <remarks>
 149             <para>
 150             Methods may return an instance of this value type when it's likely that the result of their
 151             operations will be available synchronously and when the method is expected to be invoked so
 152             frequently that the cost of allocating a new <see cref="T:System.Threading.Tasks.Task`1"/> for each call will
 153             be prohibitive.
 154             </para>
 155             <para>
 156             There are tradeoffs to using a <see cref="T:System.Threading.Tasks.ValueTask`1"/> instead of a <see cref="T:System.Threading.Tasks.Task`1"/>.
 157             For example, while a <see cref="T:System.Threading.Tasks.ValueTask`1"/> can help avoid an allocation in the case where the
 158             successful result is available synchronously, it also contains two fields whereas a <see cref="T:System.Threading.Tasks.Task`1"/>
 159             as a reference type is a single field.  This means that a method call ends up returning two fields worth of
 160             data instead of one, which is more data to copy.  It also means that if a method that returns one of these
 161             is awaited within an async method, the state machine for that async method will be larger due to needing
 162             to store the struct that's two fields instead of a single reference.
 163             </para>
 164             <para>
 165             Further, for uses other than consuming the result of an asynchronous operation via await,
 166             <see cref="T:System.Threading.Tasks.ValueTask`1"/> can lead to a more convoluted programming model, which can in turn actually
 167             lead to more allocations.  For example, consider a method that could return either a <see cref="T:System.Threading.Tasks.Task`1"/>
 168             with a cached task as a common result or a <see cref="T:System.Threading.Tasks.ValueTask`1"/>.  If the consumer of the result
 169             wants to use it as a <see cref="T:System.Threading.Tasks.Task`1"/>, such as to use with in methods like Task.WhenAll and Task.WhenAny,
 170             the <see cref="T:System.Threading.Tasks.ValueTask`1"/> would first need to be converted into a <see cref="T:System.Threading.Tasks.Task`1"/> using
 171             <see cref="M:System.Threading.Tasks.ValueTask`1.AsTask"/>, which leads to an allocation that would have been avoided if a cached
 172             <see cref="T:System.Threading.Tasks.Task`1"/> had been used in the first place.
 173             </para>
 174             <para>
 175             As such, the default choice for any asynchronous method should be to return a <see cref="T:System.Threading.Tasks.Task"/> or
 176             <see cref="T:System.Threading.Tasks.Task`1"/>. Only if performance analysis proves it worthwhile should a <see cref="T:System.Threading.Tasks.ValueTask`1"/>
 177             be used instead of <see cref="T:System.Threading.Tasks.Task`1"/>.  There is no non-generic version of <see cref="T:System.Threading.Tasks.ValueTask`1"/>
 178             as the Task.CompletedTask property may be used to hand back a successfully completed singleton in the case where
 179             a <see cref="T:System.Threading.Tasks.Task"/>-returning method completes synchronously and successfully.
 180             </para>
 181             </remarks>
 182         </member>
 183         <member name="F:System.Threading.Tasks.ValueTask`1._task">
 184             <summary>The task to be used if the operation completed asynchronously or if it completed synchronously but non-successfully.</summary>
 185         </member>
 186         <member name="F:System.Threading.Tasks.ValueTask`1._result">
 187             <summary>The result to be used if the operation completed successfully synchronously.</summary>
 188         </member>
 189         <member name="M:System.Threading.Tasks.ValueTask`1.#ctor(`0)">
 190             <summary>Initialize the <see cref="T:System.Threading.Tasks.ValueTask`1"/> with the result of the successful operation.</summary>
 191             <param name="result">The result.</param>
 192         </member>
 193         <member name="M:System.Threading.Tasks.ValueTask`1.#ctor(System.Threading.Tasks.Task{`0})">
 194             <summary>
 195             Initialize the <see cref="T:System.Threading.Tasks.ValueTask`1"/> with a <see cref="T:System.Threading.Tasks.Task`1"/> that represents the operation.
 196             </summary>
 197             <param name="task">The task.</param>
 198         </member>
 199         <member name="M:System.Threading.Tasks.ValueTask`1.GetHashCode">
 200             <summary>Returns the hash code for this instance.</summary>
 201         </member>
 202         <member name="M:System.Threading.Tasks.ValueTask`1.Equals(System.Object)">
 203             <summary>Returns a value indicating whether this value is equal to a specified <see cref="T:System.Object"/>.</summary>
 204         </member>
 205         <member name="M:System.Threading.Tasks.ValueTask`1.Equals(System.Threading.Tasks.ValueTask{`0})">
 206             <summary>Returns a value indicating whether this value is equal to a specified <see cref="T:System.Threading.Tasks.ValueTask`1"/> value.</summary>
 207         </member>
 208         <member name="M:System.Threading.Tasks.ValueTask`1.op_Equality(System.Threading.Tasks.ValueTask{`0},System.Threading.Tasks.ValueTask{`0})">
 209             <summary>Returns a value indicating whether two <see cref="T:System.Threading.Tasks.ValueTask`1"/> values are equal.</summary>
 210         </member>
 211         <member name="M:System.Threading.Tasks.ValueTask`1.op_Inequality(System.Threading.Tasks.ValueTask{`0},System.Threading.Tasks.ValueTask{`0})">
 212             <summary>Returns a value indicating whether two <see cref="T:System.Threading.Tasks.ValueTask`1"/> values are not equal.</summary>
 213         </member>
 214         <member name="M:System.Threading.Tasks.ValueTask`1.AsTask">
 215             <summary>
 216             Gets a <see cref="T:System.Threading.Tasks.Task`1"/> object to represent this ValueTask.  It will
 217             either return the wrapped task object if one exists, or it'll manufacture a new
 218             task object to represent the result.
 219             </summary>
 220         </member>
 221         <member name="P:System.Threading.Tasks.ValueTask`1.IsCompleted">
 222             <summary>Gets whether the <see cref="T:System.Threading.Tasks.ValueTask`1"/> represents a completed operation.</summary>
 223         </member>
 224         <member name="P:System.Threading.Tasks.ValueTask`1.IsCompletedSuccessfully">
 225             <summary>Gets whether the <see cref="T:System.Threading.Tasks.ValueTask`1"/> represents a successfully completed operation.</summary>
 226         </member>
 227         <member name="P:System.Threading.Tasks.ValueTask`1.IsFaulted">
 228             <summary>Gets whether the <see cref="T:System.Threading.Tasks.ValueTask`1"/> represents a failed operation.</summary>
 229         </member>
 230         <member name="P:System.Threading.Tasks.ValueTask`1.IsCanceled">
 231             <summary>Gets whether the <see cref="T:System.Threading.Tasks.ValueTask`1"/> represents a canceled operation.</summary>
 232         </member>
 233         <member name="P:System.Threading.Tasks.ValueTask`1.Result">
 234             <summary>Gets the result.</summary>
 235         </member>
 236         <member name="M:System.Threading.Tasks.ValueTask`1.GetAwaiter">
 237             <summary>Gets an awaiter for this value.</summary>
 238         </member>
 239         <member name="M:System.Threading.Tasks.ValueTask`1.ConfigureAwait(System.Boolean)">
 240             <summary>Configures an awaiter for this value.</summary>
 241             <param name="continueOnCapturedContext">
 242             true to attempt to marshal the continuation back to the captured context; otherwise, false.
 243             </param>
 244         </member>
 245         <member name="M:System.Threading.Tasks.ValueTask`1.ToString">
 246             <summary>Gets a string-representation of this <see cref="T:System.Threading.Tasks.ValueTask`1"/>.</summary>
 247         </member>
 248         <member name="M:System.Threading.Tasks.ValueTask`1.CreateAsyncMethodBuilder">
 249             <summary>Creates a method builder for use with an async method.</summary>
 250             <returns>The created builder.</returns>
 251         </member>
 252     </members>
 253 </doc>