-
Notifications
You must be signed in to change notification settings - Fork 112
/
HeaderParsingHttpRequestExtensions.xml
157 lines (157 loc) · 10.2 KB
/
HeaderParsingHttpRequestExtensions.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<Type Name="HeaderParsingHttpRequestExtensions" FullName="Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions">
<TypeSignature Language="C#" Value="public static class HeaderParsingHttpRequestExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit HeaderParsingHttpRequestExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module HeaderParsingHttpRequestExtensions" />
<TypeSignature Language="F#" Value="type HeaderParsingHttpRequestExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.HeaderParsing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Extensions for header parsing.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetHeaderParsing">
<MemberSignature Language="C#" Value="public static Microsoft.AspNetCore.HeaderParsing.HeaderParsingFeature GetHeaderParsing (this Microsoft.AspNetCore.Http.HttpRequest request);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.AspNetCore.HeaderParsing.HeaderParsingFeature GetHeaderParsing(class Microsoft.AspNetCore.Http.HttpRequest request) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.GetHeaderParsing(Microsoft.AspNetCore.Http.HttpRequest)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetHeaderParsing (request As HttpRequest) As HeaderParsingFeature" />
<MemberSignature Language="F#" Value="static member GetHeaderParsing : Microsoft.AspNetCore.Http.HttpRequest -> Microsoft.AspNetCore.HeaderParsing.HeaderParsingFeature" Usage="Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.GetHeaderParsing request" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.HeaderParsing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.HeaderParsing.HeaderParsingFeature</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="Microsoft.AspNetCore.Http.HttpRequest" RefType="this" />
</Parameters>
<Docs>
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest" /> instance.</param>
<summary>
Gets the header parsing feature to access parsed header values.
</summary>
<returns>The value of <paramref name="request" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetHeaderValue<T>">
<MemberSignature Language="C#" Value="public static bool TryGetHeaderValue<T> (this Microsoft.AspNetCore.Http.HttpRequest request, Microsoft.AspNetCore.HeaderParsing.HeaderKey<T> header, out T? value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryGetHeaderValue<T>(class Microsoft.AspNetCore.Http.HttpRequest request, class Microsoft.AspNetCore.HeaderParsing.HeaderKey`1<!!T> header, [out] !!T& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.TryGetHeaderValue``1(Microsoft.AspNetCore.Http.HttpRequest,Microsoft.AspNetCore.HeaderParsing.HeaderKey{``0},``0@)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function TryGetHeaderValue(Of T) (request As HttpRequest, header As HeaderKey(Of T), ByRef value As T) As Boolean" />
<MemberSignature Language="F#" Value="static member TryGetHeaderValue : Microsoft.AspNetCore.Http.HttpRequest * Microsoft.AspNetCore.HeaderParsing.HeaderKey<'T> * 'T -> bool" Usage="Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.TryGetHeaderValue (request, header, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.HeaderParsing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="request" Type="Microsoft.AspNetCore.Http.HttpRequest" RefType="this" />
<Parameter Name="header" Type="Microsoft.AspNetCore.HeaderParsing.HeaderKey<T>" />
<Parameter Name="value" Type="T" RefType="out">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.NotNullWhen(true)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">The type of the header value.</typeparam>
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest" /> instance.</param>
<param name="header">The header to parse.</param>
<param name="value">A resulting value.</param>
<summary>
Tries to get a header value if it exists and can be parsed.
</summary>
<returns>
<see langword="true" /> if the header value was successfully fetched parsed.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetHeaderValue<T>">
<MemberSignature Language="C#" Value="public static bool TryGetHeaderValue<T> (this Microsoft.AspNetCore.Http.HttpRequest request, Microsoft.AspNetCore.HeaderParsing.HeaderKey<T> header, out T? value, out Microsoft.AspNetCore.HeaderParsing.ParsingResult result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryGetHeaderValue<T>(class Microsoft.AspNetCore.Http.HttpRequest request, class Microsoft.AspNetCore.HeaderParsing.HeaderKey`1<!!T> header, [out] !!T& value, [out] valuetype Microsoft.AspNetCore.HeaderParsing.ParsingResult& result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.TryGetHeaderValue``1(Microsoft.AspNetCore.Http.HttpRequest,Microsoft.AspNetCore.HeaderParsing.HeaderKey{``0},``0@,Microsoft.AspNetCore.HeaderParsing.ParsingResult@)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function TryGetHeaderValue(Of T) (request As HttpRequest, header As HeaderKey(Of T), ByRef value As T, ByRef result As ParsingResult) As Boolean" />
<MemberSignature Language="F#" Value="static member TryGetHeaderValue : Microsoft.AspNetCore.Http.HttpRequest * Microsoft.AspNetCore.HeaderParsing.HeaderKey<'T> * 'T * ParsingResult -> bool" Usage="Microsoft.AspNetCore.Http.HeaderParsingHttpRequestExtensions.TryGetHeaderValue (request, header, value, result)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.HeaderParsing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="request" Type="Microsoft.AspNetCore.Http.HttpRequest" RefType="this" />
<Parameter Name="header" Type="Microsoft.AspNetCore.HeaderParsing.HeaderKey<T>" />
<Parameter Name="value" Type="T" RefType="out">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.NotNullWhen(true)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="result" Type="Microsoft.AspNetCore.HeaderParsing.ParsingResult" RefType="out" />
</Parameters>
<Docs>
<typeparam name="T">The type of the header value.</typeparam>
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest" /> instance.</param>
<param name="header">The header to parse.</param>
<param name="value">A resulting value.</param>
<param name="result">Details on the parsing operation.</param>
<summary>
Tries to get a header value if it exists and can be parsed.
</summary>
<returns>
<see langword="true" /> if the header value was successfully fetched parsed.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>