Microsoft.AspNetCore.WebUtilities.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNetCore.WebUtilities</name>
  5. </assembly>
  6. <members>
  7. <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_InvalidCountOffsetOrLength">
  8. <summary>
  9. Invalid {0}, {1} or {2} length.
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_MalformedInput">
  13. <summary>
  14. Malformed input: {0} is an invalid input length.
  15. </summary>
  16. </member>
  17. <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_InvalidCountOffsetOrLength(System.Object,System.Object,System.Object)">
  18. <summary>
  19. Invalid {0}, {1} or {2} length.
  20. </summary>
  21. </member>
  22. <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_MalformedInput(System.Object)">
  23. <summary>
  24. Malformed input: {0} is an invalid input length.
  25. </summary>
  26. </member>
  27. <member name="T:Microsoft.AspNetCore.WebUtilities.WebEncoders">
  28. <summary>
  29. Contains utility APIs to assist with common encoding and decoding operations.
  30. </summary>
  31. </member>
  32. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String)">
  33. <summary>
  34. Decodes a base64url-encoded string.
  35. </summary>
  36. <param name="input">The base64url-encoded input to decode.</param>
  37. <returns>The base64url-decoded form of the input.</returns>
  38. <remarks>
  39. The input must not contain any whitespace or padding characters.
  40. Throws <see cref="T:System.FormatException"/> if the input is malformed.
  41. </remarks>
  42. </member>
  43. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Int32)">
  44. <summary>
  45. Decodes a base64url-encoded substring of a given string.
  46. </summary>
  47. <param name="input">A string containing the base64url-encoded input to decode.</param>
  48. <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
  49. <param name="count">The number of characters in <paramref name="input"/> to decode.</param>
  50. <returns>The base64url-decoded form of the input.</returns>
  51. <remarks>
  52. The input must not contain any whitespace or padding characters.
  53. Throws <see cref="T:System.FormatException"/> if the input is malformed.
  54. </remarks>
  55. </member>
  56. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)">
  57. <summary>
  58. Decodes a base64url-encoded <paramref name="input"/> into a <c>byte[]</c>.
  59. </summary>
  60. <param name="input">A string containing the base64url-encoded input to decode.</param>
  61. <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
  62. <param name="buffer">
  63. Scratch buffer to hold the <see cref="T:System.Char"/>s to decode. Array must be large enough to hold
  64. <paramref name="bufferOffset"/> and <paramref name="count"/> characters as well as Base64 padding
  65. characters. Content is not preserved.
  66. </param>
  67. <param name="bufferOffset">
  68. The offset into <paramref name="buffer"/> at which to begin writing the <see cref="T:System.Char"/>s to decode.
  69. </param>
  70. <param name="count">The number of characters in <paramref name="input"/> to decode.</param>
  71. <returns>The base64url-decoded form of the <paramref name="input"/>.</returns>
  72. <remarks>
  73. The input must not contain any whitespace or padding characters.
  74. Throws <see cref="T:System.FormatException"/> if the input is malformed.
  75. </remarks>
  76. </member>
  77. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.GetArraySizeRequiredToDecode(System.Int32)">
  78. <summary>
  79. Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters
  80. with the <see cref="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
  81. </summary>
  82. <param name="count">The number of characters to decode.</param>
  83. <returns>
  84. The minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters.
  85. </returns>
  86. </member>
  87. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[])">
  88. <summary>
  89. Encodes <paramref name="input"/> using base64url encoding.
  90. </summary>
  91. <param name="input">The binary input to encode.</param>
  92. <returns>The base64url-encoded form of <paramref name="input"/>.</returns>
  93. </member>
  94. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Int32)">
  95. <summary>
  96. Encodes <paramref name="input"/> using base64url encoding.
  97. </summary>
  98. <param name="input">The binary input to encode.</param>
  99. <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
  100. <param name="count">The number of bytes from <paramref name="input"/> to encode.</param>
  101. <returns>The base64url-encoded form of <paramref name="input"/>.</returns>
  102. </member>
  103. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)">
  104. <summary>
  105. Encodes <paramref name="input"/> using base64url encoding.
  106. </summary>
  107. <param name="input">The binary input to encode.</param>
  108. <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
  109. <param name="output">
  110. Buffer to receive the base64url-encoded form of <paramref name="input"/>. Array must be large enough to
  111. hold <paramref name="outputOffset"/> characters and the full base64-encoded form of
  112. <paramref name="input"/>, including padding characters.
  113. </param>
  114. <param name="outputOffset">
  115. The offset into <paramref name="output"/> at which to begin writing the base64url-encoded form of
  116. <paramref name="input"/>.
  117. </param>
  118. <param name="count">The number of <c>byte</c>s from <paramref name="input"/> to encode.</param>
  119. <returns>
  120. The number of characters written to <paramref name="output"/>, less any padding characters.
  121. </returns>
  122. </member>
  123. <member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.GetArraySizeRequiredToEncode(System.Int32)">
  124. <summary>
  125. Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>
  126. <see cref="T:System.Byte"/>s with the <see cref="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
  127. </summary>
  128. <param name="count">The number of characters to encode.</param>
  129. <returns>
  130. The minimum output <c>char[]</c> size required for encoding <paramref name="count"/> <see cref="T:System.Byte"/>s.
  131. </returns>
  132. </member>
  133. <member name="M:Microsoft.AspNetCore.WebUtilities.Base64UrlTextEncoder.Encode(System.Byte[])">
  134. <summary>
  135. Encodes supplied data into Base64 and replaces any URL encodable characters into non-URL encodable
  136. characters.
  137. </summary>
  138. <param name="data">Data to be encoded.</param>
  139. <returns>Base64 encoded string modified with non-URL encodable characters</returns>
  140. </member>
  141. <member name="M:Microsoft.AspNetCore.WebUtilities.Base64UrlTextEncoder.Decode(System.String)">
  142. <summary>
  143. Decodes supplied string by replacing the non-URL encodable characters with URL encodable characters and
  144. then decodes the Base64 string.
  145. </summary>
  146. <param name="text">The string to be decoded.</param>
  147. <returns>The decoded data.</returns>
  148. </member>
  149. <member name="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream">
  150. <summary>
  151. A Stream that wraps another stream and allows reading lines.
  152. The data is buffered in memory.
  153. </summary>
  154. </member>
  155. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.#ctor(System.IO.Stream,System.Int32)">
  156. <summary>
  157. Creates a new stream.
  158. </summary>
  159. <param name="inner">The stream to wrap.</param>
  160. <param name="bufferSize">Size of buffer in bytes.</param>
  161. </member>
  162. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.#ctor(System.IO.Stream,System.Int32,System.Buffers.ArrayPool{System.Byte})">
  163. <summary>
  164. Creates a new stream.
  165. </summary>
  166. <param name="inner">The stream to wrap.</param>
  167. <param name="bufferSize">Size of buffer in bytes.</param>
  168. <param name="bytePool">ArrayPool for the buffer.</param>
  169. </member>
  170. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.BufferedData">
  171. <summary>
  172. The currently buffered data.
  173. </summary>
  174. </member>
  175. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanRead">
  176. <inheritdoc/>
  177. </member>
  178. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanSeek">
  179. <inheritdoc/>
  180. </member>
  181. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanTimeout">
  182. <inheritdoc/>
  183. </member>
  184. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanWrite">
  185. <inheritdoc/>
  186. </member>
  187. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Length">
  188. <inheritdoc/>
  189. </member>
  190. <member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Position">
  191. <inheritdoc/>
  192. </member>
  193. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Seek(System.Int64,System.IO.SeekOrigin)">
  194. <inheritdoc/>
  195. </member>
  196. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.SetLength(System.Int64)">
  197. <inheritdoc/>
  198. </member>
  199. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Dispose(System.Boolean)">
  200. <inheritdoc/>
  201. </member>
  202. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Flush">
  203. <inheritdoc/>
  204. </member>
  205. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.FlushAsync(System.Threading.CancellationToken)">
  206. <inheritdoc/>
  207. </member>
  208. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Write(System.Byte[],System.Int32,System.Int32)">
  209. <inheritdoc/>
  210. </member>
  211. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  212. <inheritdoc/>
  213. </member>
  214. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Read(System.Byte[],System.Int32,System.Int32)">
  215. <inheritdoc/>
  216. </member>
  217. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  218. <inheritdoc/>
  219. </member>
  220. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBuffered">
  221. <summary>
  222. Ensures that the buffer is not empty.
  223. </summary>
  224. <returns>Returns <c>true</c> if the buffer is not empty; <c>false</c> otherwise.</returns>
  225. </member>
  226. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBufferedAsync(System.Threading.CancellationToken)">
  227. <summary>
  228. Ensures that the buffer is not empty.
  229. </summary>
  230. <param name="cancellationToken">Cancellation token.</param>
  231. <returns>Returns <c>true</c> if the buffer is not empty; <c>false</c> otherwise.</returns>
  232. </member>
  233. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBuffered(System.Int32)">
  234. <summary>
  235. Ensures that a minimum amount of buffered data is available.
  236. </summary>
  237. <param name="minCount">Minimum amount of buffered data.</param>
  238. <returns>Returns <c>true</c> if the minimum amount of buffered data is available; <c>false</c> otherwise.</returns>
  239. </member>
  240. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBufferedAsync(System.Int32,System.Threading.CancellationToken)">
  241. <summary>
  242. Ensures that a minimum amount of buffered data is available.
  243. </summary>
  244. <param name="minCount">Minimum amount of buffered data.</param>
  245. <param name="cancellationToken">Cancellation token.</param>
  246. <returns>Returns <c>true</c> if the minimum amount of buffered data is available; <c>false</c> otherwise.</returns>
  247. </member>
  248. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadLine(System.Int32)">
  249. <summary>
  250. Reads a line. A line is defined as a sequence of characters followed by
  251. a carriage return immediately followed by a line feed. The resulting string does not
  252. contain the terminating carriage return and line feed.
  253. </summary>
  254. <param name="lengthLimit">Maximum allowed line length.</param>
  255. <returns>A line.</returns>
  256. </member>
  257. <member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadLineAsync(System.Int32,System.Threading.CancellationToken)">
  258. <summary>
  259. Reads a line. A line is defined as a sequence of characters followed by
  260. a carriage return immediately followed by a line feed. The resulting string does not
  261. contain the terminating carriage return and line feed.
  262. </summary>
  263. <param name="lengthLimit">Maximum allowed line length.</param>
  264. <param name="cancellationToken">Cancellation token.</param>
  265. <returns>A line.</returns>
  266. </member>
  267. <member name="T:Microsoft.AspNetCore.WebUtilities.FileBufferingReadStream">
  268. <summary>
  269. A Stream that wraps another stream and enables rewinding by buffering the content as it is read.
  270. The content is buffered in memory up to a certain size and then spooled to a temp file on disk.
  271. The temp file will be deleted on Dispose.
  272. </summary>
  273. </member>
  274. <member name="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection">
  275. <summary>
  276. Represents a file multipart section
  277. </summary>
  278. </member>
  279. <member name="M:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  280. <summary>
  281. Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/> class
  282. </summary>
  283. <param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/></param>
  284. <remarks>Reparses the content disposition header</remarks>
  285. </member>
  286. <member name="M:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection,Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
  287. <summary>
  288. Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/> class
  289. </summary>
  290. <param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/></param>
  291. <param name="header">An already parsed content disposition header</param>
  292. </member>
  293. <member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.Section">
  294. <summary>
  295. Gets the original section from which this object was created
  296. </summary>
  297. </member>
  298. <member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.FileStream">
  299. <summary>
  300. Gets the file stream from the section body
  301. </summary>
  302. </member>
  303. <member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.Name">
  304. <summary>
  305. Gets the name of the section
  306. </summary>
  307. </member>
  308. <member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.FileName">
  309. <summary>
  310. Gets the name of the file from the section
  311. </summary>
  312. </member>
  313. <member name="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection">
  314. <summary>
  315. Represents a form multipart section
  316. </summary>
  317. </member>
  318. <member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  319. <summary>
  320. Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/> class
  321. </summary>
  322. <param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/></param>
  323. <remarks>Reparses the content disposition header</remarks>
  324. </member>
  325. <member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection,Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
  326. <summary>
  327. Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/> class
  328. </summary>
  329. <param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/></param>
  330. <param name="header">An already parsed content disposition header</param>
  331. </member>
  332. <member name="P:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.Section">
  333. <summary>
  334. Gets the original section from which this object was created
  335. </summary>
  336. </member>
  337. <member name="P:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.Name">
  338. <summary>
  339. The form name
  340. </summary>
  341. </member>
  342. <member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.GetValueAsync">
  343. <summary>
  344. Gets the form value
  345. </summary>
  346. <returns>The form value</returns>
  347. </member>
  348. <member name="T:Microsoft.AspNetCore.WebUtilities.FormReader">
  349. <summary>
  350. Used to read an 'application/x-www-form-urlencoded' form.
  351. </summary>
  352. </member>
  353. <member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.ValueCountLimit">
  354. <summary>
  355. The limit on the number of form values to allow in ReadForm or ReadFormAsync.
  356. </summary>
  357. </member>
  358. <member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.KeyLengthLimit">
  359. <summary>
  360. The limit on the length of form keys.
  361. </summary>
  362. </member>
  363. <member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.ValueLengthLimit">
  364. <summary>
  365. The limit on the length of form values.
  366. </summary>
  367. </member>
  368. <member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadNextPair">
  369. <summary>
  370. Reads the next key value pair from the form.
  371. For unbuffered data use the async overload instead.
  372. </summary>
  373. <returns>The next key value pair, or null when the end of the form is reached.</returns>
  374. </member>
  375. <member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadNextPairAsync(System.Threading.CancellationToken)">
  376. <summary>
  377. Asynchronously reads the next key value pair from the form.
  378. </summary>
  379. <param name="cancellationToken"></param>
  380. <returns>The next key value pair, or null when the end of the form is reached.</returns>
  381. </member>
  382. <member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadForm">
  383. <summary>
  384. Parses text from an HTTP form body.
  385. </summary>
  386. <returns>The collection containing the parsed HTTP form body.</returns>
  387. </member>
  388. <member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadFormAsync(System.Threading.CancellationToken)">
  389. <summary>
  390. Parses an HTTP form body.
  391. </summary>
  392. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
  393. <returns>The collection containing the parsed HTTP form body.</returns>
  394. </member>
  395. <member name="T:Microsoft.AspNetCore.WebUtilities.HttpResponseStreamWriter">
  396. <summary>
  397. Writes to the <see cref="T:System.IO.Stream"/> using the supplied <see cref="P:Microsoft.AspNetCore.WebUtilities.HttpResponseStreamWriter.Encoding"/>.
  398. It does not write the BOM and also does not close the stream.
  399. </summary>
  400. </member>
  401. <member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.HeadersCountLimit">
  402. <summary>
  403. The limit for the number of headers to read.
  404. </summary>
  405. </member>
  406. <member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.HeadersLengthLimit">
  407. <summary>
  408. The combined size limit for headers per multipart section.
  409. </summary>
  410. </member>
  411. <member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.BodyLengthLimit">
  412. <summary>
  413. The optional limit for the total response body length.
  414. </summary>
  415. </member>
  416. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartReaderStream.#ctor(Microsoft.AspNetCore.WebUtilities.BufferedReadStream,Microsoft.AspNetCore.WebUtilities.MultipartBoundary)">
  417. <summary>
  418. Creates a stream that reads until it reaches the given boundary pattern.
  419. </summary>
  420. <param name="stream">The <see cref="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream"/>.</param>
  421. <param name="boundary">The boundary pattern to use.</param>
  422. </member>
  423. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartReaderStream.#ctor(Microsoft.AspNetCore.WebUtilities.BufferedReadStream,Microsoft.AspNetCore.WebUtilities.MultipartBoundary,System.Buffers.ArrayPool{System.Byte})">
  424. <summary>
  425. Creates a stream that reads until it reaches the given boundary pattern.
  426. </summary>
  427. <param name="stream">The <see cref="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream"/>.</param>
  428. <param name="boundary">The boundary pattern to use.</param>
  429. <param name="bytePool">The ArrayPool pool to use for temporary byte arrays.</param>
  430. </member>
  431. <member name="P:Microsoft.AspNetCore.WebUtilities.MultipartSection.BaseStreamOffset">
  432. <summary>
  433. The position where the body starts in the total multipart body.
  434. This may not be available if the total multipart body is not seekable.
  435. </summary>
  436. </member>
  437. <member name="T:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions">
  438. <summary>
  439. Various extensions for converting multipart sections
  440. </summary>
  441. </member>
  442. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.AsFileSection(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  443. <summary>
  444. Converts the section to a file section
  445. </summary>
  446. <param name="section">The section to convert</param>
  447. <returns>A file section</returns>
  448. </member>
  449. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.AsFormDataSection(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  450. <summary>
  451. Converts the section to a form section
  452. </summary>
  453. <param name="section">The section to convert</param>
  454. <returns>A form section</returns>
  455. </member>
  456. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.GetContentDispositionHeader(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  457. <summary>
  458. Retrieves and parses the content disposition header from a section
  459. </summary>
  460. <param name="section">The section from which to retrieve</param>
  461. <returns>A <see cref="T:Microsoft.Net.Http.Headers.ContentDispositionHeaderValue"/> if the header was found, null otherwise</returns>
  462. </member>
  463. <member name="T:Microsoft.AspNetCore.WebUtilities.MultipartSectionStreamExtensions">
  464. <summary>
  465. Various extension methods for dealing with the section body stream
  466. </summary>
  467. </member>
  468. <member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionStreamExtensions.ReadAsStringAsync(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
  469. <summary>
  470. Reads the body of the section as a string
  471. </summary>
  472. <param name="section">The section to read from</param>
  473. <returns>The body steam as string</returns>
  474. </member>
  475. <member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.AddQueryString(System.String,System.String,System.String)">
  476. <summary>
  477. Append the given query key and value to the URI.
  478. </summary>
  479. <param name="uri">The base URI.</param>
  480. <param name="name">The name of the query key.</param>
  481. <param name="value">The query value.</param>
  482. <returns>The combined result.</returns>
  483. </member>
  484. <member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.AddQueryString(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
  485. <summary>
  486. Append the given query keys and values to the uri.
  487. </summary>
  488. <param name="uri">The base uri.</param>
  489. <param name="queryString">A collection of name value query pairs to append.</param>
  490. <returns>The combined result.</returns>
  491. </member>
  492. <member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseQuery(System.String)">
  493. <summary>
  494. Parse a query string into its component key and value parts.
  495. </summary>
  496. <param name="queryString">The raw query string value, with or without the leading '?'.</param>
  497. <returns>A collection of parsed keys and values.</returns>
  498. </member>
  499. <member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseNullableQuery(System.String)">
  500. <summary>
  501. Parse a query string into its component key and value parts.
  502. </summary>
  503. <param name="queryString">The raw query string value, with or without the leading '?'.</param>
  504. <returns>A collection of parsed keys and values, null if there are no entries.</returns>
  505. </member>
  506. <member name="T:Microsoft.AspNetCore.WebUtilities.Resources">
  507. <summary>
  508. A strongly-typed resource class, for looking up localized strings, etc.
  509. </summary>
  510. </member>
  511. <member name="P:Microsoft.AspNetCore.WebUtilities.Resources.ResourceManager">
  512. <summary>
  513. Returns the cached ResourceManager instance used by this class.
  514. </summary>
  515. </member>
  516. <member name="P:Microsoft.AspNetCore.WebUtilities.Resources.Culture">
  517. <summary>
  518. Overrides the current thread's CurrentUICulture property for all
  519. resource lookups using this strongly typed resource class.
  520. </summary>
  521. </member>
  522. <member name="P:Microsoft.AspNetCore.WebUtilities.Resources.HttpRequestStreamReader_StreamNotReadable">
  523. <summary>
  524. Looks up a localized string similar to The stream must support reading..
  525. </summary>
  526. </member>
  527. <member name="P:Microsoft.AspNetCore.WebUtilities.Resources.HttpResponseStreamWriter_StreamNotWritable">
  528. <summary>
  529. Looks up a localized string similar to The stream must support writing..
  530. </summary>
  531. </member>
  532. <member name="P:Microsoft.AspNetCore.WebUtilities.Resources.WebEncoders_InvalidCountOffsetOrLength">
  533. <summary>
  534. Looks up a localized string similar to Invalid {0}, {1} or {2} length..
  535. </summary>
  536. </member>
  537. </members>
  538. </doc>