/
TaskExtensions.xml
83 lines (83 loc) · 4.94 KB
/
TaskExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<Type Name="TaskExtensions" FullName="CommunityToolkit.Common.TaskExtensions">
<TypeSignature Language="C#" Value="public static class TaskExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit TaskExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:CommunityToolkit.Common.TaskExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module TaskExtensions" />
<TypeSignature Language="F#" Value="type TaskExtensions = class" />
<AssemblyInfo>
<AssemblyName>CommunityToolkit.Common</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Helpers for working with tasks.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetResultOrDefault">
<MemberSignature Language="C#" Value="public static object? GetResultOrDefault (this System.Threading.Tasks.Task task);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object GetResultOrDefault(class System.Threading.Tasks.Task task) cil managed" />
<MemberSignature Language="DocId" Value="M:CommunityToolkit.Common.TaskExtensions.GetResultOrDefault(System.Threading.Tasks.Task)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetResultOrDefault (task As Task) As Object" />
<MemberSignature Language="F#" Value="static member GetResultOrDefault : System.Threading.Tasks.Task -> obj" Usage="CommunityToolkit.Common.TaskExtensions.GetResultOrDefault task" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>CommunityToolkit.Common</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="task" Type="System.Threading.Tasks.Task" RefType="this" />
</Parameters>
<Docs>
<param name="task">The input <see cref="T:System.Threading.Tasks.Task" /> instance to get the result for.</param>
<summary>
Gets the result of a <see cref="T:System.Threading.Tasks.Task" /> if available, or <see langword="null" /> otherwise.
</summary>
<returns>The result of <paramref name="task" /> if completed successfully, or <see langword="default" /> otherwise.</returns>
<remarks>
This method does not block if <paramref name="task" /> has not completed yet. Furthermore, it is not generic
and uses reflection to access the <see cref="P:System.Threading.Tasks.Task`1.Result" /> property and boxes the result if it's
a value type, which adds overhead. It should only be used when using generics is not possible.
</remarks>
</Docs>
</Member>
<Member MemberName="GetResultOrDefault<T>">
<MemberSignature Language="C#" Value="public static T? GetResultOrDefault<T> (this System.Threading.Tasks.Task<T?> task);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T GetResultOrDefault<T>(class System.Threading.Tasks.Task`1<!!T> task) cil managed" />
<MemberSignature Language="DocId" Value="M:CommunityToolkit.Common.TaskExtensions.GetResultOrDefault``1(System.Threading.Tasks.Task{``0})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetResultOrDefault(Of T) (task As Task(Of T)) As T" />
<MemberSignature Language="F#" Value="static member GetResultOrDefault : System.Threading.Tasks.Task<'T> -> 'T" Usage="CommunityToolkit.Common.TaskExtensions.GetResultOrDefault task" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>CommunityToolkit.Common</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="task" Type="System.Threading.Tasks.Task<T>" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">The type of <see cref="T:System.Threading.Tasks.Task`1" /> to get the result for.</typeparam>
<param name="task">The input <see cref="T:System.Threading.Tasks.Task`1" /> instance to get the result for.</param>
<summary>
Gets the result of a <see cref="T:System.Threading.Tasks.Task`1" /> if available, or <see langword="default" /> otherwise.
</summary>
<returns>The result of <paramref name="task" /> if completed successfully, or <see langword="default" /> otherwise.</returns>
<remarks>This method does not block if <paramref name="task" /> has not completed yet.</remarks>
</Docs>
</Member>
</Members>
</Type>