163 lines
8.4 KiB
XML
163 lines
8.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>System.Memory.Data</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:System.BinaryData">
|
|
<summary>
|
|
A lightweight abstraction for a payload of bytes that supports converting between string, stream, JSON, and bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:System.BinaryData.#ctor(System.Byte[])">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by wrapping the
|
|
provided byte array.
|
|
</summary>
|
|
<param name="data">The array to wrap.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.#ctor(System.Object,System.Text.Json.JsonSerializerOptions,System.Type)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object to JSON
|
|
using <see cref="T:System.Text.Json.JsonSerializer" />.
|
|
</summary>
|
|
|
|
<param name="jsonSerializable">The object that will be serialized to JSON using
|
|
<see cref="T:System.Text.Json.JsonSerializer" />.</param>
|
|
<param name="options">The options to use when serializing to JSON.</param>
|
|
<param name="type">The type to use when serializing the data. If not specified, <see cref="M:System.Object.GetType" /> will
|
|
be used to determine the type.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.#ctor(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by wrapping the
|
|
provided bytes.
|
|
</summary>
|
|
<param name="data">Byte data to wrap.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.#ctor(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance from a string by converting
|
|
the string to bytes using the UTF-8 encoding.
|
|
</summary>
|
|
<param name="data">The string data.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromBytes(System.ReadOnlyMemory{System.Byte})">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided
|
|
<see cref="T:System.ReadOnlyMemory`1" />.
|
|
</summary>
|
|
<param name="data">Byte data to wrap.</param>
|
|
<returns>A wrapper over <paramref name="data" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromBytes(System.Byte[])">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided
|
|
byte array.
|
|
</summary>
|
|
<param name="data">The array to wrap.</param>
|
|
<returns>A wrapper over <paramref name="data" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromString(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance from a string by converting
|
|
the string to bytes using the UTF-8 encoding.
|
|
</summary>
|
|
<param name="data">The string data.</param>
|
|
<returns>A value representing the UTF-8 encoding of <paramref name="data" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromStream(System.IO.Stream)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance from the specified stream.
|
|
The stream is not disposed by this method.
|
|
</summary>
|
|
<param name="stream">Stream containing the data.</param>
|
|
<returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromStreamAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance from the specified stream.
|
|
The stream is not disposed by this method.
|
|
</summary>
|
|
<param name="stream">Stream containing the data.</param>
|
|
<param name="cancellationToken">A token that may be used to cancel the operation.</param>
|
|
<returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions)">
|
|
<summary>
|
|
Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object using
|
|
the <see cref="T:System.Text.Json.JsonSerializer" />.
|
|
</summary>
|
|
|
|
<typeparam name="T">The type to use when serializing the data.</typeparam>
|
|
<param name="jsonSerializable">The data to use.</param>
|
|
<param name="options">The options to use when serializing to JSON.</param>
|
|
|
|
<returns>A value representing the UTF-8 encoding of the JSON representation of <paramref name="jsonSerializable" />.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.ToString">
|
|
<summary>
|
|
Converts the value of this instance to a string using UTF-8.
|
|
</summary>
|
|
<returns>
|
|
A string from the value of this instance, using UTF-8 to decode the bytes.
|
|
</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.ToStream">
|
|
<summary>
|
|
Converts the <see cref="T:System.BinaryData" /> to a read-only stream.
|
|
</summary>
|
|
<returns>A stream representing the data.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.ToMemory">
|
|
<summary>
|
|
Gets the value of this instance as bytes without any further interpretation.
|
|
</summary>
|
|
<returns>The value of this instance as bytes without any further interpretation.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.ToArray">
|
|
<summary>
|
|
Converts the <see cref="T:System.BinaryData" /> to a byte array.
|
|
</summary>
|
|
<returns>A byte array representing the data.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.ToObjectFromJson``1(System.Text.Json.JsonSerializerOptions)">
|
|
<summary>
|
|
Converts the <see cref="T:System.BinaryData" /> to the specified type using
|
|
<see cref="T:System.Text.Json.JsonSerializer" />.
|
|
</summary>
|
|
<typeparam name="T">The type that the data should be
|
|
converted to.</typeparam>
|
|
<param name="options">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> to use when serializing to JSON.</param>
|
|
<returns>The data converted to the specified type.</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.op_Implicit(System.BinaryData)~System.ReadOnlyMemory{System.Byte}">
|
|
<summary>
|
|
Defines an implicit conversion from a <see cref="T:System.BinaryData" /> to a <see cref="T:System.ReadOnlyMemory`1" />.
|
|
</summary>
|
|
<param name="data">The value to be converted.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.op_Implicit(System.BinaryData)~System.ReadOnlySpan{System.Byte}">
|
|
<summary>
|
|
Defines an implicit conversion from a <see cref="T:System.BinaryData" /> to a <see cref="T:System.ReadOnlySpan`1" />.
|
|
</summary>
|
|
<param name="data">The value to be converted.</param>
|
|
</member>
|
|
<member name="M:System.BinaryData.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified object is equal to the current object.
|
|
</summary>
|
|
<param name="obj">The object to compare with the current object.</param>
|
|
<returns>
|
|
<see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.
|
|
</returns>
|
|
</member>
|
|
<member name="M:System.BinaryData.GetHashCode">
|
|
<summary>Serves as the default hash function.</summary><returns>A hash code for the current object.</returns>
|
|
</member>
|
|
<member name="T:System.IO.ReadOnlyMemoryStream">
|
|
<summary>Provides a <see cref="T:System.IO.Stream" /> for the contents of a <see cref="T:System.ReadOnlyMemory`1" />.</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|