K4os.Hash.xxHash.xml 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>K4os.Hash.xxHash</name>
  5. </assembly>
  6. <members>
  7. <member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
  8. <summary>
  9. Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
  10. </summary>
  11. </member>
  12. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
  13. <summary>
  14. Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
  15. </summary>
  16. <param name="hashSize">Hash size (in bytes)</param>
  17. <param name="reset">Reset function.</param>
  18. <param name="update">Update function.</param>
  19. <param name="digest">Digest function.</param>
  20. </member>
  21. <member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
  22. <inheritdoc />
  23. </member>
  24. <member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
  25. <inheritdoc />
  26. </member>
  27. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
  28. <inheritdoc />
  29. </member>
  30. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
  31. <inheritdoc />
  32. </member>
  33. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
  34. <inheritdoc />
  35. </member>
  36. <member name="T:K4os.Hash.xxHash.XXH">
  37. <summary>
  38. Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
  39. </summary>
  40. </member>
  41. <member name="M:K4os.Hash.xxHash.XXH.#ctor">
  42. <summary>Protected constructor to prevent instantiation.</summary>
  43. </member>
  44. <member name="T:K4os.Hash.xxHash.XXH32">
  45. <summary>
  46. xxHash 32-bit.
  47. </summary>
  48. </member>
  49. <member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
  50. <summary>Hash of empty buffer.</summary>
  51. </member>
  52. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
  53. <summary>Hash of provided buffer.</summary>
  54. <param name="bytes">Buffer.</param>
  55. <param name="length">Length of buffer.</param>
  56. <returns>Digest.</returns>
  57. </member>
  58. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
  59. <summary>Hash of provided buffer.</summary>
  60. <param name="bytes">Buffer.</param>
  61. <returns>Digest.</returns>
  62. </member>
  63. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
  64. <summary>Hash of provided buffer.</summary>
  65. <param name="bytes">Buffer.</param>
  66. <param name="offset">Starting offset.</param>
  67. <param name="length">Length of buffer.</param>
  68. <returns>Digest.</returns>
  69. </member>
  70. <member name="M:K4os.Hash.xxHash.XXH32.#ctor">
  71. <summary>Creates xxHash instance.</summary>
  72. </member>
  73. <member name="M:K4os.Hash.xxHash.XXH32.Reset">
  74. <summary>Resets hash calculation.</summary>
  75. </member>
  76. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
  77. <summary>Updates the has using given buffer.</summary>
  78. <param name="bytes">Buffer.</param>
  79. <param name="length">Length of buffer.</param>
  80. </member>
  81. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
  82. <summary>Updates the has using given buffer.</summary>
  83. <param name="bytes">Buffer.</param>
  84. </member>
  85. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
  86. <summary>Updates the has using given buffer.</summary>
  87. <param name="bytes">Buffer.</param>
  88. <param name="offset">Starting offset.</param>
  89. <param name="length">Length of buffer.</param>
  90. </member>
  91. <member name="M:K4os.Hash.xxHash.XXH32.Digest">
  92. <summary>Hash so far.</summary>
  93. <returns>Hash so far.</returns>
  94. </member>
  95. <member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
  96. <summary>Hash so far, as byte array.</summary>
  97. <returns>Hash so far.</returns>
  98. </member>
  99. <member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
  100. <summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
  101. <returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
  102. </member>
  103. <member name="T:K4os.Hash.xxHash.XXH64">
  104. <summary>
  105. xxHash 64-bit.
  106. </summary>
  107. </member>
  108. <member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
  109. <summary>Hash of empty buffer.</summary>
  110. </member>
  111. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
  112. <summary>Hash of provided buffer.</summary>
  113. <param name="bytes">Buffer.</param>
  114. <param name="length">Length of buffer.</param>
  115. <returns>Digest.</returns>
  116. </member>
  117. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
  118. <summary>Hash of provided buffer.</summary>
  119. <param name="bytes">Buffer.</param>
  120. <returns>Digest.</returns>
  121. </member>
  122. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
  123. <summary>Hash of provided buffer.</summary>
  124. <param name="bytes">Buffer.</param>
  125. <param name="offset">Starting offset.</param>
  126. <param name="length">Length of buffer.</param>
  127. <returns>Digest.</returns>
  128. </member>
  129. <member name="M:K4os.Hash.xxHash.XXH64.#ctor">
  130. <summary>Creates xxHash instance.</summary>
  131. </member>
  132. <member name="M:K4os.Hash.xxHash.XXH64.Reset">
  133. <summary>Resets hash calculation.</summary>
  134. </member>
  135. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
  136. <summary>Updates the has using given buffer.</summary>
  137. <param name="bytes">Buffer.</param>
  138. <param name="length">Length of buffer.</param>
  139. </member>
  140. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
  141. <summary>Updates the has using given buffer.</summary>
  142. <param name="bytes">Buffer.</param>
  143. </member>
  144. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
  145. <summary>Updates the has using given buffer.</summary>
  146. <param name="bytes">Buffer.</param>
  147. <param name="offset">Starting offset.</param>
  148. <param name="length">Length of buffer.</param>
  149. </member>
  150. <member name="M:K4os.Hash.xxHash.XXH64.Digest">
  151. <summary>Hash so far.</summary>
  152. <returns>Hash so far.</returns>
  153. </member>
  154. <member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
  155. <summary>Hash so far, as byte array.</summary>
  156. <returns>Hash so far.</returns>
  157. </member>
  158. <member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
  159. <summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
  160. <returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
  161. </member>
  162. </members>
  163. </doc>