System.Memory.Data.xml 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Memory.Data</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.BinaryData">
  8. <summary>
  9. A lightweight abstraction for a payload of bytes that supports converting between string, stream, JSON, and bytes.
  10. </summary>
  11. </member>
  12. <member name="M:System.BinaryData.#ctor(System.Byte[])">
  13. <summary>
  14. Creates a <see cref="T:System.BinaryData" /> instance by wrapping the
  15. provided byte array.
  16. </summary>
  17. <param name="data">The array to wrap.</param>
  18. </member>
  19. <member name="M:System.BinaryData.#ctor(System.Object,System.Text.Json.JsonSerializerOptions,System.Type)">
  20. <summary>
  21. Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object to JSON
  22. using <see cref="T:System.Text.Json.JsonSerializer" />.
  23. </summary>
  24. <param name="jsonSerializable">The object that will be serialized to JSON using
  25. <see cref="T:System.Text.Json.JsonSerializer" />.</param>
  26. <param name="options">The options to use when serializing to JSON.</param>
  27. <param name="type">The type to use when serializing the data. If not specified, <see cref="M:System.Object.GetType" /> will
  28. be used to determine the type.</param>
  29. </member>
  30. <member name="M:System.BinaryData.#ctor(System.ReadOnlyMemory{System.Byte})">
  31. <summary>
  32. Creates a <see cref="T:System.BinaryData" /> instance by wrapping the
  33. provided bytes.
  34. </summary>
  35. <param name="data">Byte data to wrap.</param>
  36. </member>
  37. <member name="M:System.BinaryData.#ctor(System.String)">
  38. <summary>
  39. Creates a <see cref="T:System.BinaryData" /> instance from a string by converting
  40. the string to bytes using the UTF-8 encoding.
  41. </summary>
  42. <param name="data">The string data.</param>
  43. </member>
  44. <member name="M:System.BinaryData.FromBytes(System.ReadOnlyMemory{System.Byte})">
  45. <summary>
  46. Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided
  47. <see cref="T:System.ReadOnlyMemory`1" />.
  48. </summary>
  49. <param name="data">Byte data to wrap.</param>
  50. <returns>A wrapper over <paramref name="data" />.</returns>
  51. </member>
  52. <member name="M:System.BinaryData.FromBytes(System.Byte[])">
  53. <summary>
  54. Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided
  55. byte array.
  56. </summary>
  57. <param name="data">The array to wrap.</param>
  58. <returns>A wrapper over <paramref name="data" />.</returns>
  59. </member>
  60. <member name="M:System.BinaryData.FromString(System.String)">
  61. <summary>
  62. Creates a <see cref="T:System.BinaryData" /> instance from a string by converting
  63. the string to bytes using the UTF-8 encoding.
  64. </summary>
  65. <param name="data">The string data.</param>
  66. <returns>A value representing the UTF-8 encoding of <paramref name="data" />.</returns>
  67. </member>
  68. <member name="M:System.BinaryData.FromStream(System.IO.Stream)">
  69. <summary>
  70. Creates a <see cref="T:System.BinaryData" /> instance from the specified stream.
  71. The stream is not disposed by this method.
  72. </summary>
  73. <param name="stream">Stream containing the data.</param>
  74. <returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
  75. </member>
  76. <member name="M:System.BinaryData.FromStreamAsync(System.IO.Stream,System.Threading.CancellationToken)">
  77. <summary>
  78. Creates a <see cref="T:System.BinaryData" /> instance from the specified stream.
  79. The stream is not disposed by this method.
  80. </summary>
  81. <param name="stream">Stream containing the data.</param>
  82. <param name="cancellationToken">A token that may be used to cancel the operation.</param>
  83. <returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
  84. </member>
  85. <member name="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)">
  86. <summary>
  87. Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object using
  88. the <see cref="T:System.Text.Json.JsonSerializer" />.
  89. </summary>
  90. <typeparam name="T">The type to use when serializing the data.</typeparam>
  91. <param name="jsonSerializable">The data to use.</param>
  92. <param name="options">The options to use when serializing to JSON.</param>
  93. <returns>A value representing the UTF-8 encoding of the JSON representation of <paramref name="jsonSerializable" />.</returns>
  94. </member>
  95. <member name="M:System.BinaryData.ToString">
  96. <summary>
  97. Converts the value of this instance to a string using UTF-8.
  98. </summary>
  99. <returns>
  100. A string from the value of this instance, using UTF-8 to decode the bytes.
  101. </returns>
  102. </member>
  103. <member name="M:System.BinaryData.ToStream">
  104. <summary>
  105. Converts the <see cref="T:System.BinaryData" /> to a read-only stream.
  106. </summary>
  107. <returns>A stream representing the data.</returns>
  108. </member>
  109. <member name="M:System.BinaryData.ToMemory">
  110. <summary>
  111. Gets the value of this instance as bytes without any further interpretation.
  112. </summary>
  113. <returns>The value of this instance as bytes without any further interpretation.</returns>
  114. </member>
  115. <member name="M:System.BinaryData.ToArray">
  116. <summary>
  117. Converts the <see cref="T:System.BinaryData" /> to a byte array.
  118. </summary>
  119. <returns>A byte array representing the data.</returns>
  120. </member>
  121. <member name="M:System.BinaryData.ToObjectFromJson``1(System.Text.Json.JsonSerializerOptions)">
  122. <summary>
  123. Converts the <see cref="T:System.BinaryData" /> to the specified type using
  124. <see cref="T:System.Text.Json.JsonSerializer" />.
  125. </summary>
  126. <typeparam name="T">The type that the data should be
  127. converted to.</typeparam>
  128. <param name="options">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> to use when serializing to JSON.</param>
  129. <returns>The data converted to the specified type.</returns>
  130. </member>
  131. <member name="M:System.BinaryData.op_Implicit(System.BinaryData)~System.ReadOnlyMemory{System.Byte}">
  132. <summary>
  133. Defines an implicit conversion from a <see cref="T:System.BinaryData" /> to a <see cref="T:System.ReadOnlyMemory`1" />.
  134. </summary>
  135. <param name="data">The value to be converted.</param>
  136. </member>
  137. <member name="M:System.BinaryData.op_Implicit(System.BinaryData)~System.ReadOnlySpan{System.Byte}">
  138. <summary>
  139. Defines an implicit conversion from a <see cref="T:System.BinaryData" /> to a <see cref="T:System.ReadOnlySpan`1" />.
  140. </summary>
  141. <param name="data">The value to be converted.</param>
  142. </member>
  143. <member name="M:System.BinaryData.Equals(System.Object)">
  144. <summary>
  145. Determines whether the specified object is equal to the current object.
  146. </summary>
  147. <param name="obj">The object to compare with the current object.</param>
  148. <returns>
  149. <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.
  150. </returns>
  151. </member>
  152. <member name="M:System.BinaryData.GetHashCode">
  153. <summary>Serves as the default hash function.</summary><returns>A hash code for the current object.</returns>
  154. </member>
  155. <member name="T:System.IO.ReadOnlyMemoryStream">
  156. <summary>Provides a <see cref="T:System.IO.Stream" /> for the contents of a <see cref="T:System.ReadOnlyMemory`1" />.</summary>
  157. </member>
  158. </members>
  159. </doc>