/
ParseResultExtensions.xml
137 lines (137 loc) · 9.66 KB
/
ParseResultExtensions.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<Type Name="ParseResultExtensions" FullName="System.CommandLine.Parsing.ParseResultExtensions">
<TypeSignature Language="C#" Value="public static class ParseResultExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ParseResultExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.CommandLine.Parsing.ParseResultExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ParseResultExtensions" />
<TypeSignature Language="F#" Value="type ParseResultExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ParseResultExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides extension methods for parse results.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Diagram">
<MemberSignature Language="C#" Value="public static string Diagram (this System.CommandLine.Parsing.ParseResult parseResult);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string Diagram(class System.CommandLine.Parsing.ParseResult parseResult) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ParseResultExtensions.Diagram(System.CommandLine.Parsing.ParseResult)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function Diagram (parseResult As ParseResult) As String" />
<MemberSignature Language="F#" Value="static member Diagram : System.CommandLine.Parsing.ParseResult -> string" Usage="System.CommandLine.Parsing.ParseResultExtensions.Diagram parseResult" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static System::String ^ Diagram(System::CommandLine::Parsing::ParseResult ^ parseResult);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parseResult" Type="System.CommandLine.Parsing.ParseResult" RefType="this" />
</Parameters>
<Docs>
<param name="parseResult">The parse result to be diagrammed.</param>
<summary>
Formats a string explaining a parse result.
</summary>
<returns>A string containing a diagram of the parse result.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasOption">
<MemberSignature Language="C#" Value="public static bool HasOption (this System.CommandLine.Parsing.ParseResult parseResult, System.CommandLine.Option option);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool HasOption(class System.CommandLine.Parsing.ParseResult parseResult, class System.CommandLine.Option option) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ParseResultExtensions.HasOption(System.CommandLine.Parsing.ParseResult,System.CommandLine.Option)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function HasOption (parseResult As ParseResult, option As Option) As Boolean" />
<MemberSignature Language="F#" Value="static member HasOption : System.CommandLine.Parsing.ParseResult * System.CommandLine.Option -> bool" Usage="System.CommandLine.Parsing.ParseResultExtensions.HasOption (parseResult, option)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static bool HasOption(System::CommandLine::Parsing::ParseResult ^ parseResult, System::CommandLine::Option ^ option);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parseResult" Type="System.CommandLine.Parsing.ParseResult" RefType="this" />
<Parameter Name="option" Type="System.CommandLine.Option" />
</Parameters>
<Docs>
<param name="parseResult">The parse result to check for the presence of the option.</param>
<param name="option">The option to check for the presence of.</param>
<summary>
Indicates whether a given option is present in the parse result.
</summary>
<returns>
<see langword="true" /> if the option is present; otherwise, <see langword="false" />.</returns>
<remarks>If the option has a default value defined, then <see langword="true" /> will be returned.</remarks>
</Docs>
</Member>
<Member MemberName="Invoke">
<MemberSignature Language="C#" Value="public static int Invoke (this System.CommandLine.Parsing.ParseResult parseResult, System.CommandLine.IConsole? console = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 Invoke(class System.CommandLine.Parsing.ParseResult parseResult, class System.CommandLine.IConsole console) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ParseResultExtensions.Invoke(System.CommandLine.Parsing.ParseResult,System.CommandLine.IConsole)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function Invoke (parseResult As ParseResult, Optional console As IConsole = Nothing) As Integer" />
<MemberSignature Language="F#" Value="static member Invoke : System.CommandLine.Parsing.ParseResult * System.CommandLine.IConsole -> int" Usage="System.CommandLine.Parsing.ParseResultExtensions.Invoke (parseResult, console)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parseResult" Type="System.CommandLine.Parsing.ParseResult" RefType="this" />
<Parameter Name="console" Type="System.CommandLine.IConsole" />
</Parameters>
<Docs>
<param name="parseResult">A parse result on which the invocation is based.</param>
<param name="console">A console to which output can be written. By default, <see cref="T:System.Console" /> is used.</param>
<summary>
Invokes the appropriate command handler for a parsed command line input.
</summary>
<returns>A value that can be used as a process exit code.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InvokeAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<int> InvokeAsync (this System.CommandLine.Parsing.ParseResult parseResult, System.CommandLine.IConsole? console = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<int32> InvokeAsync(class System.CommandLine.Parsing.ParseResult parseResult, class System.CommandLine.IConsole console) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ParseResultExtensions.InvokeAsync(System.CommandLine.Parsing.ParseResult,System.CommandLine.IConsole)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function InvokeAsync (parseResult As ParseResult, Optional console As IConsole = Nothing) As Task(Of Integer)" />
<MemberSignature Language="F#" Value="static member InvokeAsync : System.CommandLine.Parsing.ParseResult * System.CommandLine.IConsole -> System.Threading.Tasks.Task<int>" Usage="System.CommandLine.Parsing.ParseResultExtensions.InvokeAsync (parseResult, console)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int32></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parseResult" Type="System.CommandLine.Parsing.ParseResult" RefType="this" />
<Parameter Name="console" Type="System.CommandLine.IConsole" />
</Parameters>
<Docs>
<param name="parseResult">A parse result on which the invocation is based.</param>
<param name="console">A console to which output can be written. By default, <see cref="T:System.Console" /> is used.</param>
<summary>
Invokes the appropriate command handler for a parsed command line input.
</summary>
<returns>A task whose result can be used as a process exit code.</returns>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:System.CommandLine.Parsing.ParseResultExtensions.Invoke(System.CommandLine.Parsing.ParseResult,System.CommandLine.IConsole)" />.</remarks>
</Docs>
</Member>
</Members>
</Type>