System.IO.Hashing.xml 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>System.IO.Hashing</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.IO.Hashing.Crc32">
  8. <summary>
  9. Provides an implementation of the CRC-32 algorithm, as used in
  10. ITU-T V.42 and IEEE 802.3.
  11. </summary>
  12. <remarks>
  13. <para>
  14. This implementation emits the answer in the Little Endian byte order so that
  15. the CRC residue relationship (CRC(message concat CRC(message))) is a fixed value) holds.
  16. For CRC-32 this stable output is the byte sequence <c>{ 0x1C, 0xDF, 0x44, 0x21 }</c>,
  17. the Little Endian representation of <c>0x2144DF1C</c>.
  18. </para>
  19. <para>
  20. There are multiple, incompatible, definitions of a 32-bit cyclic redundancy
  21. check (CRC) algorithm. When interoperating with another system, ensure that you
  22. are using the same definition. The definition used by this implementation is not
  23. compatible with the cyclic redundancy check described in ITU-T I.363.5.
  24. </para>
  25. </remarks>
  26. </member>
  27. <member name="M:System.IO.Hashing.Crc32.#ctor">
  28. <summary>
  29. Initializes a new instance of the <see cref="T:System.IO.Hashing.Crc32"/> class.
  30. </summary>
  31. </member>
  32. <member name="M:System.IO.Hashing.Crc32.Append(System.ReadOnlySpan{System.Byte})">
  33. <summary>
  34. Appends the contents of <paramref name="source"/> to the data already
  35. processed for the current hash computation.
  36. </summary>
  37. <param name="source">The data to process.</param>
  38. </member>
  39. <member name="M:System.IO.Hashing.Crc32.Reset">
  40. <summary>
  41. Resets the hash computation to the initial state.
  42. </summary>
  43. </member>
  44. <member name="M:System.IO.Hashing.Crc32.GetCurrentHashCore(System.Span{System.Byte})">
  45. <summary>
  46. Writes the computed hash value to <paramref name="destination"/>
  47. without modifying accumulated state.
  48. </summary>
  49. <param name="destination">The buffer that receives the computed hash value.</param>
  50. </member>
  51. <member name="M:System.IO.Hashing.Crc32.GetHashAndResetCore(System.Span{System.Byte})">
  52. <summary>
  53. Writes the computed hash value to <paramref name="destination"/>
  54. then clears the accumulated state.
  55. </summary>
  56. </member>
  57. <member name="M:System.IO.Hashing.Crc32.Hash(System.Byte[])">
  58. <summary>
  59. Computes the CRC-32 hash of the provided data.
  60. </summary>
  61. <param name="source">The data to hash.</param>
  62. <returns>The CRC-32 hash of the provided data.</returns>
  63. <exception cref="T:System.ArgumentNullException">
  64. <paramref name="source"/> is <see langword="null"/>.
  65. </exception>
  66. </member>
  67. <member name="M:System.IO.Hashing.Crc32.Hash(System.ReadOnlySpan{System.Byte})">
  68. <summary>
  69. Computes the CRC-32 hash of the provided data.
  70. </summary>
  71. <param name="source">The data to hash.</param>
  72. <returns>The CRC-32 hash of the provided data.</returns>
  73. </member>
  74. <member name="M:System.IO.Hashing.Crc32.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
  75. <summary>
  76. Attempts to compute the CRC-32 hash of the provided data into the provided destination.
  77. </summary>
  78. <param name="source">The data to hash.</param>
  79. <param name="destination">The buffer that receives the computed hash value.</param>
  80. <param name="bytesWritten">
  81. On success, receives the number of bytes written to <paramref name="destination"/>.
  82. </param>
  83. <returns>
  84. <see langword="true"/> if <paramref name="destination"/> is long enough to receive
  85. the computed hash value (4 bytes); otherwise, <see langword="false"/>.
  86. </returns>
  87. </member>
  88. <member name="M:System.IO.Hashing.Crc32.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
  89. <summary>
  90. Computes the CRC-32 hash of the provided data into the provided destination.
  91. </summary>
  92. <param name="source">The data to hash.</param>
  93. <param name="destination">The buffer that receives the computed hash value.</param>
  94. <returns>
  95. The number of bytes written to <paramref name="destination"/>.
  96. </returns>
  97. </member>
  98. <member name="T:System.IO.Hashing.Crc64">
  99. <summary>
  100. Provides an implementation of the CRC-64 algorithm as described in ECMA-182, Annex B.
  101. </summary>
  102. <remarks>
  103. <para>
  104. This implementation emits the answer in the Big Endian byte order so that
  105. the CRC residue relationship (CRC(message concat CRC(message))) is a fixed value) holds.
  106. For CRC-64 this stable output is the byte sequence
  107. <c>{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }</c>.
  108. </para>
  109. <para>
  110. There are multiple, incompatible, definitions of a 64-bit cyclic redundancy
  111. check (CRC) algorithm. When interoperating with another system, ensure that you
  112. are using the same definition. The definition used by this implementation is not
  113. compatible with the cyclic redundancy check described in ISO 3309.
  114. </para>
  115. </remarks>
  116. </member>
  117. <member name="M:System.IO.Hashing.Crc64.#ctor">
  118. <summary>
  119. Initializes a new instance of the <see cref="T:System.IO.Hashing.Crc64"/> class.
  120. </summary>
  121. </member>
  122. <member name="M:System.IO.Hashing.Crc64.Append(System.ReadOnlySpan{System.Byte})">
  123. <summary>
  124. Appends the contents of <paramref name="source"/> to the data already
  125. processed for the current hash computation.
  126. </summary>
  127. <param name="source">The data to process.</param>
  128. </member>
  129. <member name="M:System.IO.Hashing.Crc64.Reset">
  130. <summary>
  131. Resets the hash computation to the initial state.
  132. </summary>
  133. </member>
  134. <member name="M:System.IO.Hashing.Crc64.GetCurrentHashCore(System.Span{System.Byte})">
  135. <summary>
  136. Writes the computed hash value to <paramref name="destination"/>
  137. without modifying accumulated state.
  138. </summary>
  139. <param name="destination">The buffer that receives the computed hash value.</param>
  140. </member>
  141. <member name="M:System.IO.Hashing.Crc64.GetHashAndResetCore(System.Span{System.Byte})">
  142. <summary>
  143. Writes the computed hash value to <paramref name="destination"/>
  144. then clears the accumulated state.
  145. </summary>
  146. </member>
  147. <member name="M:System.IO.Hashing.Crc64.Hash(System.Byte[])">
  148. <summary>
  149. Computes the CRC-64 hash of the provided data.
  150. </summary>
  151. <param name="source">The data to hash.</param>
  152. <returns>The CRC-64 hash of the provided data.</returns>
  153. <exception cref="T:System.ArgumentNullException">
  154. <paramref name="source"/> is <see langword="null"/>.
  155. </exception>
  156. </member>
  157. <member name="M:System.IO.Hashing.Crc64.Hash(System.ReadOnlySpan{System.Byte})">
  158. <summary>
  159. Computes the CRC-64 hash of the provided data.
  160. </summary>
  161. <param name="source">The data to hash.</param>
  162. <returns>The CRC-64 hash of the provided data.</returns>
  163. </member>
  164. <member name="M:System.IO.Hashing.Crc64.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
  165. <summary>
  166. Attempts to compute the CRC-64 hash of the provided data into the provided destination.
  167. </summary>
  168. <param name="source">The data to hash.</param>
  169. <param name="destination">The buffer that receives the computed hash value.</param>
  170. <param name="bytesWritten">
  171. On success, receives the number of bytes written to <paramref name="destination"/>.
  172. </param>
  173. <returns>
  174. <see langword="true"/> if <paramref name="destination"/> is long enough to receive
  175. the computed hash value (8 bytes); otherwise, <see langword="false"/>.
  176. </returns>
  177. </member>
  178. <member name="M:System.IO.Hashing.Crc64.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
  179. <summary>
  180. Computes the CRC-64 hash of the provided data into the provided destination.
  181. </summary>
  182. <param name="source">The data to hash.</param>
  183. <param name="destination">The buffer that receives the computed hash value.</param>
  184. <returns>
  185. The number of bytes written to <paramref name="destination"/>.
  186. </returns>
  187. </member>
  188. <member name="T:System.IO.Hashing.XxHash32">
  189. <summary>
  190. Provides an implementation of the XxHash32 algorithm.
  191. </summary>
  192. </member>
  193. <member name="M:System.IO.Hashing.XxHash32.#ctor">
  194. <summary>
  195. Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32"/> class.
  196. </summary>
  197. <remarks>
  198. The XxHash32 algorithm supports an optional seed value.
  199. Instances created with this constructor use the default seed, zero.
  200. </remarks>
  201. </member>
  202. <member name="M:System.IO.Hashing.XxHash32.#ctor(System.Int32)">
  203. <summary>
  204. Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32"/> class with
  205. a specified seed.
  206. </summary>
  207. <param name="seed">
  208. The hash seed value for computations from this instance.
  209. </param>
  210. </member>
  211. <member name="M:System.IO.Hashing.XxHash32.Reset">
  212. <summary>
  213. Resets the hash computation to the initial state.
  214. </summary>
  215. </member>
  216. <member name="M:System.IO.Hashing.XxHash32.Append(System.ReadOnlySpan{System.Byte})">
  217. <summary>
  218. Appends the contents of <paramref name="source"/> to the data already
  219. processed for the current hash computation.
  220. </summary>
  221. <param name="source">The data to process.</param>
  222. </member>
  223. <member name="M:System.IO.Hashing.XxHash32.GetCurrentHashCore(System.Span{System.Byte})">
  224. <summary>
  225. Writes the computed hash value to <paramref name="destination"/>
  226. without modifying accumulated state.
  227. </summary>
  228. </member>
  229. <member name="M:System.IO.Hashing.XxHash32.Hash(System.Byte[])">
  230. <summary>
  231. Computes the XxHash32 hash of the provided data.
  232. </summary>
  233. <param name="source">The data to hash.</param>
  234. <returns>The XxHash32 hash of the provided data.</returns>
  235. <exception cref="T:System.ArgumentNullException">
  236. <paramref name="source"/> is <see langword="null"/>.
  237. </exception>
  238. </member>
  239. <member name="M:System.IO.Hashing.XxHash32.Hash(System.Byte[],System.Int32)">
  240. <summary>
  241. Computes the XxHash32 hash of the provided data using the provided seed.
  242. </summary>
  243. <param name="source">The data to hash.</param>
  244. <param name="seed">The seed value for this hash computation.</param>
  245. <returns>The XxHash32 hash of the provided data.</returns>
  246. <exception cref="T:System.ArgumentNullException">
  247. <paramref name="source"/> is <see langword="null"/>.
  248. </exception>
  249. </member>
  250. <member name="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Int32)">
  251. <summary>
  252. Computes the XxHash32 hash of the provided data.
  253. </summary>
  254. <param name="source">The data to hash.</param>
  255. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  256. <returns>The XxHash32 hash of the provided data.</returns>
  257. </member>
  258. <member name="M:System.IO.Hashing.XxHash32.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32)">
  259. <summary>
  260. Attempts to compute the XxHash32 hash of the provided data into the provided destination.
  261. </summary>
  262. <param name="source">The data to hash.</param>
  263. <param name="destination">The buffer that receives the computed hash value.</param>
  264. <param name="bytesWritten">
  265. On success, receives the number of bytes written to <paramref name="destination"/>.
  266. </param>
  267. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  268. <returns>
  269. <see langword="true"/> if <paramref name="destination"/> is long enough to receive
  270. the computed hash value (4 bytes); otherwise, <see langword="false"/>.
  271. </returns>
  272. </member>
  273. <member name="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32)">
  274. <summary>
  275. Computes the XxHash32 hash of the provided data into the provided destination.
  276. </summary>
  277. <param name="source">The data to hash.</param>
  278. <param name="destination">The buffer that receives the computed hash value.</param>
  279. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  280. <returns>
  281. The number of bytes written to <paramref name="destination"/>.
  282. </returns>
  283. </member>
  284. <member name="T:System.IO.Hashing.XxHash64">
  285. <summary>
  286. Provides an implementation of the XxHash64 algorithm.
  287. </summary>
  288. </member>
  289. <member name="M:System.IO.Hashing.XxHash64.#ctor">
  290. <summary>
  291. Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash64"/> class.
  292. </summary>
  293. <remarks>
  294. The XxHash64 algorithm supports an optional seed value.
  295. Instances created with this constructor use the default seed, zero.
  296. </remarks>
  297. </member>
  298. <member name="M:System.IO.Hashing.XxHash64.#ctor(System.Int64)">
  299. <summary>
  300. Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash64"/> class with
  301. a specified seed.
  302. </summary>
  303. <param name="seed">
  304. The hash seed value for computations from this instance.
  305. </param>
  306. </member>
  307. <member name="M:System.IO.Hashing.XxHash64.Reset">
  308. <summary>
  309. Resets the hash computation to the initial state.
  310. </summary>
  311. </member>
  312. <member name="M:System.IO.Hashing.XxHash64.Append(System.ReadOnlySpan{System.Byte})">
  313. <summary>
  314. Appends the contents of <paramref name="source"/> to the data already
  315. processed for the current hash computation.
  316. </summary>
  317. <param name="source">The data to process.</param>
  318. </member>
  319. <member name="M:System.IO.Hashing.XxHash64.GetCurrentHashCore(System.Span{System.Byte})">
  320. <summary>
  321. Writes the computed hash value to <paramref name="destination"/>
  322. without modifying accumulated state.
  323. </summary>
  324. </member>
  325. <member name="M:System.IO.Hashing.XxHash64.Hash(System.Byte[])">
  326. <summary>
  327. Computes the XxHash64 hash of the provided data.
  328. </summary>
  329. <param name="source">The data to hash.</param>
  330. <returns>The XxHash64 hash of the provided data.</returns>
  331. <exception cref="T:System.ArgumentNullException">
  332. <paramref name="source"/> is <see langword="null"/>.
  333. </exception>
  334. </member>
  335. <member name="M:System.IO.Hashing.XxHash64.Hash(System.Byte[],System.Int64)">
  336. <summary>
  337. Computes the XxHash64 hash of the provided data using the provided seed.
  338. </summary>
  339. <param name="source">The data to hash.</param>
  340. <param name="seed">The seed value for this hash computation.</param>
  341. <returns>The XxHash64 hash of the provided data.</returns>
  342. <exception cref="T:System.ArgumentNullException">
  343. <paramref name="source"/> is <see langword="null"/>.
  344. </exception>
  345. </member>
  346. <member name="M:System.IO.Hashing.XxHash64.Hash(System.ReadOnlySpan{System.Byte},System.Int64)">
  347. <summary>
  348. Computes the XxHash64 hash of the provided data.
  349. </summary>
  350. <param name="source">The data to hash.</param>
  351. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  352. <returns>The XxHash64 hash of the provided data.</returns>
  353. </member>
  354. <member name="M:System.IO.Hashing.XxHash64.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int64)">
  355. <summary>
  356. Attempts to compute the XxHash64 hash of the provided data into the provided destination.
  357. </summary>
  358. <param name="source">The data to hash.</param>
  359. <param name="destination">The buffer that receives the computed hash value.</param>
  360. <param name="bytesWritten">
  361. On success, receives the number of bytes written to <paramref name="destination"/>.
  362. </param>
  363. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  364. <returns>
  365. <see langword="true"/> if <paramref name="destination"/> is long enough to receive
  366. the computed hash value (4 bytes); otherwise, <see langword="false"/>.
  367. </returns>
  368. </member>
  369. <member name="M:System.IO.Hashing.XxHash64.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int64)">
  370. <summary>
  371. Computes the XxHash64 hash of the provided data into the provided destination.
  372. </summary>
  373. <param name="source">The data to hash.</param>
  374. <param name="destination">The buffer that receives the computed hash value.</param>
  375. <param name="seed">The seed value for this hash computation. The default is zero.</param>
  376. <returns>
  377. The number of bytes written to <paramref name="destination"/>.
  378. </returns>
  379. </member>
  380. <member name="T:System.IO.Hashing.NonCryptographicHashAlgorithm">
  381. <summary>
  382. Represents a non-cryptographic hash algorithm.
  383. </summary>
  384. </member>
  385. <member name="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes">
  386. <summary>
  387. Gets the number of bytes produced from this hash algorithm.
  388. </summary>
  389. <value>The number of bytes produced from this hash algorithm.</value>
  390. </member>
  391. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.#ctor(System.Int32)">
  392. <summary>
  393. Called from constructors in derived classes to initialize the
  394. <see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class.
  395. </summary>
  396. <param name="hashLengthInBytes">
  397. The number of bytes produced from this hash algorithm.
  398. </param>
  399. <exception cref="T:System.ArgumentOutOfRangeException">
  400. <paramref name="hashLengthInBytes"/> is less than 1.
  401. </exception>
  402. </member>
  403. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.ReadOnlySpan{System.Byte})">
  404. <summary>
  405. When overridden in a derived class,
  406. appends the contents of <paramref name="source"/> to the data already
  407. processed for the current hash computation.
  408. </summary>
  409. <param name="source">The data to process.</param>
  410. </member>
  411. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Reset">
  412. <summary>
  413. When overridden in a derived class,
  414. resets the hash computation to the initial state.
  415. </summary>
  416. </member>
  417. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHashCore(System.Span{System.Byte})">
  418. <summary>
  419. When overridden in a derived class,
  420. writes the computed hash value to <paramref name="destination"/>
  421. without modifying accumulated state.
  422. </summary>
  423. <param name="destination">The buffer that receives the computed hash value.</param>
  424. <remarks>
  425. <para>
  426. Implementations of this method must write exactly
  427. <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> bytes to <paramref name="destination"/>.
  428. Do not assume that the buffer was zero-initialized.
  429. </para>
  430. <para>
  431. The <see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class validates the
  432. size of the buffer before calling this method, and slices the span
  433. down to be exactly <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> in length.
  434. </para>
  435. </remarks>
  436. </member>
  437. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.Byte[])">
  438. <summary>
  439. Appends the contents of <paramref name="source"/> to the data already
  440. processed for the current hash computation.
  441. </summary>
  442. <param name="source">The data to process.</param>
  443. <exception cref="T:System.ArgumentNullException">
  444. <paramref name="source"/> is <see langword="null"/>.
  445. </exception>
  446. </member>
  447. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.IO.Stream)">
  448. <summary>
  449. Appends the contents of <paramref name="stream"/> to the data already
  450. processed for the current hash computation.
  451. </summary>
  452. <param name="stream">The data to process.</param>
  453. <exception cref="T:System.ArgumentNullException">
  454. <paramref name="stream"/> is <see langword="null"/>.
  455. </exception>
  456. <seealso cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.AppendAsync(System.IO.Stream,System.Threading.CancellationToken)"/>
  457. </member>
  458. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.AppendAsync(System.IO.Stream,System.Threading.CancellationToken)">
  459. <summary>
  460. Asychronously reads the contents of <paramref name="stream"/>
  461. and appends them to the data already
  462. processed for the current hash computation.
  463. </summary>
  464. <param name="stream">The data to process.</param>
  465. <param name="cancellationToken">
  466. The token to monitor for cancellation requests.
  467. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
  468. </param>
  469. <returns>
  470. A task that represents the asynchronous append operation.
  471. </returns>
  472. <exception cref="T:System.ArgumentNullException">
  473. <paramref name="stream"/> is <see langword="null"/>.
  474. </exception>
  475. </member>
  476. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash">
  477. <summary>
  478. Gets the current computed hash value without modifying accumulated state.
  479. </summary>
  480. <returns>
  481. The hash value for the data already provided.
  482. </returns>
  483. </member>
  484. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.TryGetCurrentHash(System.Span{System.Byte},System.Int32@)">
  485. <summary>
  486. Attempts to write the computed hash value to <paramref name="destination"/>
  487. without modifying accumulated state.
  488. </summary>
  489. <param name="destination">The buffer that receives the computed hash value.</param>
  490. <param name="bytesWritten">
  491. On success, receives the number of bytes written to <paramref name="destination"/>.
  492. </param>
  493. <returns>
  494. <see langword="true"/> if <paramref name="destination"/> is long enough to receive
  495. the computed hash value; otherwise, <see langword="false"/>.
  496. </returns>
  497. </member>
  498. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash(System.Span{System.Byte})">
  499. <summary>
  500. Writes the computed hash value to <paramref name="destination"/>
  501. without modifying accumulated state.
  502. </summary>
  503. <param name="destination">The buffer that receives the computed hash value.</param>
  504. <returns>
  505. The number of bytes written to <paramref name="destination"/>,
  506. which is always <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
  507. </returns>
  508. <exception cref="T:System.ArgumentException">
  509. <paramref name="destination"/> is shorter than <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
  510. </exception>
  511. </member>
  512. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset">
  513. <summary>
  514. Gets the current computed hash value and clears the accumulated state.
  515. </summary>
  516. <returns>
  517. The hash value for the data already provided.
  518. </returns>
  519. </member>
  520. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.TryGetHashAndReset(System.Span{System.Byte},System.Int32@)">
  521. <summary>
  522. Attempts to write the computed hash value to <paramref name="destination"/>.
  523. If successful, clears the accumulated state.
  524. </summary>
  525. <param name="destination">The buffer that receives the computed hash value.</param>
  526. <param name="bytesWritten">
  527. On success, receives the number of bytes written to <paramref name="destination"/>.
  528. </param>
  529. <returns>
  530. <see langword="true"/> and clears the accumulated state
  531. if <paramref name="destination"/> is long enough to receive
  532. the computed hash value; otherwise, <see langword="false"/>.
  533. </returns>
  534. </member>
  535. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset(System.Span{System.Byte})">
  536. <summary>
  537. Writes the computed hash value to <paramref name="destination"/>
  538. then clears the accumulated state.
  539. </summary>
  540. <param name="destination">The buffer that receives the computed hash value.</param>
  541. <returns>
  542. The number of bytes written to <paramref name="destination"/>,
  543. which is always <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
  544. </returns>
  545. <exception cref="T:System.ArgumentException">
  546. <paramref name="destination"/> is shorter than <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
  547. </exception>
  548. </member>
  549. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndResetCore(System.Span{System.Byte})">
  550. <summary>
  551. Writes the computed hash value to <paramref name="destination"/>
  552. then clears the accumulated state.
  553. </summary>
  554. <param name="destination">The buffer that receives the computed hash value.</param>
  555. <remarks>
  556. <para>
  557. Implementations of this method must write exactly
  558. <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> bytes to <paramref name="destination"/>.
  559. Do not assume that the buffer was zero-initialized.
  560. </para>
  561. <para>
  562. The <see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class validates the
  563. size of the buffer before calling this method, and slices the span
  564. down to be exactly <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> in length.
  565. </para>
  566. <para>
  567. The default implementation of this method calls
  568. <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHashCore(System.Span{System.Byte})"/> followed by <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Reset"/>.
  569. Overrides of this method do not need to call either of those methods,
  570. but must ensure that the caller cannot observe a difference in behavior.
  571. </para>
  572. </remarks>
  573. </member>
  574. <member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashCode">
  575. <summary>
  576. This method is not supported and should not be called.
  577. Call <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash"/> or <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset"/>
  578. instead.
  579. </summary>
  580. <returns>This method will always throw a <see cref="T:System.NotSupportedException"/>.</returns>
  581. <exception cref="T:System.NotSupportedException">In all cases.</exception>
  582. </member>
  583. <member name="P:System.SR.Argument_DestinationTooShort">
  584. <summary>Destination is too short.</summary>
  585. </member>
  586. <member name="P:System.SR.NotSupported_GetHashCode">
  587. <summary>The GetHashCode method is not supported on this object. Use GetCurrentHash or GetHashAndReset to retrieve the hash code computed by this object.</summary>
  588. </member>
  589. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  590. <summary>
  591. Attribute used to indicate a source generator should create a function for marshalling
  592. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  593. </summary>
  594. <remarks>
  595. This attribute is meaningless if the source generator associated with it is not enabled.
  596. The current built-in source generator only supports C# and only supplies an implementation when
  597. applied to static, partial, non-generic methods.
  598. </remarks>
  599. </member>
  600. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  601. <summary>
  602. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  603. </summary>
  604. <param name="libraryName">Name of the library containing the import.</param>
  605. </member>
  606. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  607. <summary>
  608. Gets the name of the library containing the import.
  609. </summary>
  610. </member>
  611. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  612. <summary>
  613. Gets or sets the name of the entry point to be called.
  614. </summary>
  615. </member>
  616. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  617. <summary>
  618. Gets or sets how to marshal string arguments to the method.
  619. </summary>
  620. <remarks>
  621. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  622. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  623. </remarks>
  624. </member>
  625. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  626. <summary>
  627. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  628. </summary>
  629. <remarks>
  630. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  631. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  632. </remarks>
  633. </member>
  634. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  635. <summary>
  636. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  637. on other platforms) before returning from the attributed method.
  638. </summary>
  639. </member>
  640. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  641. <summary>
  642. Specifies how strings should be marshalled for generated p/invokes
  643. </summary>
  644. </member>
  645. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  646. <summary>
  647. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  648. </summary>
  649. </member>
  650. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  651. <summary>
  652. Use the platform-provided UTF-8 marshaller.
  653. </summary>
  654. </member>
  655. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  656. <summary>
  657. Use the platform-provided UTF-16 marshaller.
  658. </summary>
  659. </member>
  660. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  661. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  662. </member>
  663. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  664. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  665. </member>
  666. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  667. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  668. </member>
  669. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  670. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  671. </member>
  672. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  673. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  674. </member>
  675. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  676. <summary>Initializes the attribute with the specified return value condition.</summary>
  677. <param name="returnValue">
  678. The return value condition. If the method returns this value, the associated parameter may be null.
  679. </param>
  680. </member>
  681. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  682. <summary>Gets the return value condition.</summary>
  683. </member>
  684. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  685. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  686. </member>
  687. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  688. <summary>Initializes the attribute with the specified return value condition.</summary>
  689. <param name="returnValue">
  690. The return value condition. If the method returns this value, the associated parameter will not be null.
  691. </param>
  692. </member>
  693. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  694. <summary>Gets the return value condition.</summary>
  695. </member>
  696. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  697. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  698. </member>
  699. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  700. <summary>Initializes the attribute with the associated parameter name.</summary>
  701. <param name="parameterName">
  702. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  703. </param>
  704. </member>
  705. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  706. <summary>Gets the associated parameter name.</summary>
  707. </member>
  708. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  709. <summary>Applied to a method that will never return under any circumstance.</summary>
  710. </member>
  711. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  712. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  713. </member>
  714. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  715. <summary>Initializes the attribute with the specified parameter value.</summary>
  716. <param name="parameterValue">
  717. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  718. the associated parameter matches this value.
  719. </param>
  720. </member>
  721. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  722. <summary>Gets the condition parameter value.</summary>
  723. </member>
  724. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  725. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  726. </member>
  727. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  728. <summary>Initializes the attribute with a field or property member.</summary>
  729. <param name="member">
  730. The field or property member that is promised to be not-null.
  731. </param>
  732. </member>
  733. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  734. <summary>Initializes the attribute with the list of field and property members.</summary>
  735. <param name="members">
  736. The list of field and property members that are promised to be not-null.
  737. </param>
  738. </member>
  739. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  740. <summary>Gets field or property member names.</summary>
  741. </member>
  742. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  743. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  744. </member>
  745. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  746. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  747. <param name="returnValue">
  748. The return value condition. If the method returns this value, the associated parameter will not be null.
  749. </param>
  750. <param name="member">
  751. The field or property member that is promised to be not-null.
  752. </param>
  753. </member>
  754. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  755. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  756. <param name="returnValue">
  757. The return value condition. If the method returns this value, the associated parameter will not be null.
  758. </param>
  759. <param name="members">
  760. The list of field and property members that are promised to be not-null.
  761. </param>
  762. </member>
  763. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  764. <summary>Gets the return value condition.</summary>
  765. </member>
  766. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  767. <summary>Gets field or property member names.</summary>
  768. </member>
  769. </members>
  770. </doc>