ObjectSerializer.xml

<Type Name="ObjectSerializer" FullName="Azure.Core.Serialization.ObjectSerializer">
  <TypeSignature Language="C#" Value="public abstract class ObjectSerializer" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ObjectSerializer extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Core.Serialization.ObjectSerializer" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class ObjectSerializer" />
  <TypeSignature Language="F#" Value="type ObjectSerializer = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Core</AssemblyName>
    <AssemblyVersion>1.13.0.0</AssemblyVersion>
    <AssemblyVersion>1.14.0.0</AssemblyVersion>
    <AssemblyVersion>1.15.0.0</AssemblyVersion>
    <AssemblyVersion>1.16.0.0</AssemblyVersion>
    <AssemblyVersion>1.17.0.0</AssemblyVersion>
    <AssemblyVersion>1.18.0.0</AssemblyVersion>
    <AssemblyVersion>1.19.0.0</AssemblyVersion>
    <AssemblyVersion>1.20.0.0</AssemblyVersion>
    <AssemblyVersion>1.21.0.0</AssemblyVersion>
    <AssemblyVersion>1.22.0.0</AssemblyVersion>
    <AssemblyVersion>1.23.0.0</AssemblyVersion>
    <AssemblyVersion>1.24.0.0</AssemblyVersion>
    <AssemblyVersion>1.25.0.0</AssemblyVersion>
    <AssemblyVersion>1.26.0.0</AssemblyVersion>
    <AssemblyVersion>1.27.0.0</AssemblyVersion>
    <AssemblyVersion>1.28.0.0</AssemblyVersion>
    <AssemblyVersion>1.29.0.0</AssemblyVersion>
    <AssemblyVersion>1.30.0.0</AssemblyVersion>
    <AssemblyVersion>1.31.0.0</AssemblyVersion>
    <AssemblyVersion>1.32.0.0</AssemblyVersion>
    <AssemblyVersion>1.33.0.0</AssemblyVersion>
    <AssemblyVersion>1.34.0.0</AssemblyVersion>
    <AssemblyVersion>1.35.0.0</AssemblyVersion>
    <AssemblyVersion>1.36.0.0</AssemblyVersion>
    <AssemblyVersion>1.37.0.0</AssemblyVersion>
    <AssemblyVersion>1.38.0.0</AssemblyVersion>
    <AssemblyVersion>1.39.0.0</AssemblyVersion>
    <AssemblyVersion>1.40.0.0</AssemblyVersion>
    <AssemblyVersion>1.41.0.0</AssemblyVersion>
    <AssemblyVersion>1.42.0.0</AssemblyVersion>
    <AssemblyVersion>1.43.0.0</AssemblyVersion>
    <AssemblyVersion>1.44.0.0</AssemblyVersion>
    <AssemblyVersion>1.44.1.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            An abstraction for reading typed objects.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ObjectSerializer ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Deserialize">
      <MemberSignature Language="C#" Value="public abstract object? Deserialize (System.IO.Stream stream, Type returnType, System.Threading.CancellationToken cancellationToken);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Deserialize(class System.IO.Stream stream, class System.Type returnType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.Deserialize(System.IO.Stream,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function Deserialize (stream As Stream, returnType As Type, cancellationToken As CancellationToken) As Object" />
      <MemberSignature Language="F#" Value="abstract member Deserialize : System.IO.Stream * Type * System.Threading.CancellationToken -&gt; obj" Usage="objectSerializer.Deserialize (stream, returnType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="returnType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The <see cref="T:System.IO.Stream" /> to read from.</param>
        <param name="returnType">The type of the object to convert to and return.</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
        <summary>
            Read the binary representation into a <paramref name="returnType" />.
            The Stream will be read to completion.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DeserializeAsync">
      <MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask&lt;object?&gt; DeserializeAsync (System.IO.Stream stream, Type returnType, System.Threading.CancellationToken cancellationToken);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;object&gt; DeserializeAsync(class System.IO.Stream stream, class System.Type returnType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function DeserializeAsync (stream As Stream, returnType As Type, cancellationToken As CancellationToken) As ValueTask(Of Object)" />
      <MemberSignature Language="F#" Value="abstract member DeserializeAsync : System.IO.Stream * Type * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;obj&gt;" Usage="objectSerializer.DeserializeAsync (stream, returnType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.ValueTask&lt;System.Object&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="returnType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The <see cref="T:System.IO.Stream" /> to read from.</param>
        <param name="returnType">The type of the object to convert to and return.</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
        <summary>
            Read the binary representation into a <paramref name="returnType" />.
            The Stream will be read to completion.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Serialize">
      <MemberSignature Language="C#" Value="public virtual BinaryData Serialize (object? value, Type? inputType = default, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.BinaryData Serialize(object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.Serialize(System.Object,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Function Serialize (value As Object, Optional inputType As Type = Nothing, Optional cancellationToken As CancellationToken = Nothing) As BinaryData" />
      <MemberSignature Language="F#" Value="abstract member Serialize : obj * Type * System.Threading.CancellationToken -&gt; BinaryData&#xA;override this.Serialize : obj * Type * System.Threading.CancellationToken -&gt; BinaryData" Usage="objectSerializer.Serialize (value, inputType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.BinaryData</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Object" />
        <Parameter Name="inputType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="value">The value to convert.</param>
        <param name="inputType">The type to use when serializing <paramref name="value" />. If omitted, the type will be determined using <see cref="M:System.Object.GetType" />().</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
        <summary>
            Convert the provided value to it's binary representation and return it as a <see cref="T:System.BinaryData" /> instance.
            </summary>
        <returns>The object's binary representation as <see cref="T:System.BinaryData" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Serialize">
      <MemberSignature Language="C#" Value="public abstract void Serialize (System.IO.Stream stream, object? value, Type inputType, System.Threading.CancellationToken cancellationToken);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Serialize(class System.IO.Stream stream, object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.Serialize(System.IO.Stream,System.Object,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Sub Serialize (stream As Stream, value As Object, inputType As Type, cancellationToken As CancellationToken)" />
      <MemberSignature Language="F#" Value="abstract member Serialize : System.IO.Stream * obj * Type * System.Threading.CancellationToken -&gt; unit" Usage="objectSerializer.Serialize (stream, value, inputType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="value" Type="System.Object" />
        <Parameter Name="inputType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The <see cref="T:System.IO.Stream" /> to write to.</param>
        <param name="value">The value to convert.</param>
        <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
        <summary>
            Convert the provided value to it's binary representation and write it to <see cref="T:System.IO.Stream" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SerializeAsync">
      <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask&lt;BinaryData&gt; SerializeAsync (object? value, Type? inputType = default, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class System.BinaryData&gt; SerializeAsync(object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.SerializeAsync(System.Object,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Function SerializeAsync (value As Object, Optional inputType As Type = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of BinaryData)" />
      <MemberSignature Language="F#" Value="abstract member SerializeAsync : obj * Type * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;BinaryData&gt;&#xA;override this.SerializeAsync : obj * Type * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;BinaryData&gt;" Usage="objectSerializer.SerializeAsync (value, inputType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.ValueTask&lt;System.BinaryData&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Object" />
        <Parameter Name="inputType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="value">The value to convert.</param>
        <param name="inputType">The type to use when serializing <paramref name="value" />. If omitted, the type will be determined using <see cref="M:System.Object.GetType" />().</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
        <summary>
            Convert the provided value to it's binary representation and return it as a <see cref="T:System.BinaryData" /> instance.
            </summary>
        <returns>The object's binary representation as <see cref="T:System.BinaryData" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SerializeAsync">
      <MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask SerializeAsync (System.IO.Stream stream, object? value, Type inputType, System.Threading.CancellationToken cancellationToken);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask SerializeAsync(class System.IO.Stream stream, object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.ObjectSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function SerializeAsync (stream As Stream, value As Object, inputType As Type, cancellationToken As CancellationToken) As ValueTask" />
      <MemberSignature Language="F#" Value="abstract member SerializeAsync : System.IO.Stream * obj * Type * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask" Usage="objectSerializer.SerializeAsync (stream, value, inputType, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core</AssemblyName>
        <AssemblyVersion>1.44.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
        <Parameter Name="value" Type="System.Object" />
        <Parameter Name="inputType" Type="System.Type" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
      </Parameters>
      <Docs>
        <param name="stream">The <see cref="T:System.IO.Stream" /> to write to.</param>
        <param name="value">The value to convert.</param>
        <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
        <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
        <summary>
            Convert the provided value to it's binary representation and write it to <see cref="T:System.IO.Stream" />.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>