xml/System.ClientModel.Primitives/ModelReaderWriter.xml (314 lines of code) (raw):
<Type Name="ModelReaderWriter" FullName="System.ClientModel.Primitives.ModelReaderWriter">
<TypeSignature Language="C#" Value="public static class ModelReaderWriter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ModelReaderWriter extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ModelReaderWriter" />
<TypeSignature Language="VB.NET" Value="Public Class ModelReaderWriter" />
<TypeSignature Language="F#" Value="type ModelReaderWriter = class" />
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides functionality to read and write <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" /> and <see cref="T:System.ClientModel.Primitives.IJsonModel`1" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public static object? Read (BinaryData data, Type returnType, System.ClientModel.Primitives.ModelReaderWriterOptions? options = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object Read(class System.BinaryData data, class System.Type returnType, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Read(System.BinaryData,System.Type,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Read (data As BinaryData, returnType As Type, Optional options As ModelReaderWriterOptions = Nothing) As Object" />
<MemberSignature Language="F#" Value="static member Read : BinaryData * Type * System.ClientModel.Primitives.ModelReaderWriterOptions -> obj" Usage="System.ClientModel.Primitives.ModelReaderWriter.Read (data, returnType, options)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" />
<Parameter Name="returnType" Type="System.Type" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="data">The <see cref="T:System.BinaryData" /> to convert.</param>
<param name="returnType">The type of the object to convert and return.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> into a <paramref name="returnType" />.
</summary>
<returns>A <paramref name="returnType" /> representation of the <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <paramref name="returnType" /> does not have a public or internal parameterless constructor.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="data" /> or <paramref name="returnType" /> are null.</exception>
<exception cref="T:System.MissingMethodException">If <paramref name="returnType" /> does not have a public or non public empty constructor.</exception>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public static object? Read (BinaryData data, Type returnType, System.ClientModel.Primitives.ModelReaderWriterOptions options, System.ClientModel.Primitives.ModelReaderWriterContext context);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object Read(class System.BinaryData data, class System.Type returnType, class System.ClientModel.Primitives.ModelReaderWriterOptions options, class System.ClientModel.Primitives.ModelReaderWriterContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Read(System.BinaryData,System.Type,System.ClientModel.Primitives.ModelReaderWriterOptions,System.ClientModel.Primitives.ModelReaderWriterContext)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Read (data As BinaryData, returnType As Type, options As ModelReaderWriterOptions, context As ModelReaderWriterContext) As Object" />
<MemberSignature Language="F#" Value="static member Read : BinaryData * Type * System.ClientModel.Primitives.ModelReaderWriterOptions * System.ClientModel.Primitives.ModelReaderWriterContext -> obj" Usage="System.ClientModel.Primitives.ModelReaderWriter.Read (data, returnType, options, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" />
<Parameter Name="returnType" Type="System.Type" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
<Parameter Name="context" Type="System.ClientModel.Primitives.ModelReaderWriterContext" />
</Parameters>
<Docs>
<param name="data">The <see cref="T:System.BinaryData" /> to convert.</param>
<param name="returnType">The type of the object to convert and return.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<param name="context">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterContext" /> to use.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> into a <paramref name="returnType" />.
</summary>
<returns>A <paramref name="returnType" /> representation of the <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <paramref name="returnType" /> does not have a public or internal parameterless constructor.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="data" /> or <paramref name="returnType" /> are null.</exception>
<exception cref="T:System.MissingMethodException">If <paramref name="returnType" /> does not have a public or non public empty constructor.</exception>
</Docs>
</Member>
<Member MemberName="Read<T>">
<MemberSignature Language="C#" Value="public static T? Read<T> (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions? options = default) where T : System.ClientModel.Primitives.IPersistableModel<T>;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T Read<(class System.ClientModel.Primitives.IPersistableModel`1<!!T>) T>(class System.BinaryData data, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Read``1(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Read(Of T As IPersistableModel(Of T)) (data As BinaryData, Optional options As ModelReaderWriterOptions = Nothing) As T" />
<MemberSignature Language="F#" Value="static member Read : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions -> 'T (requires 'T :> System.ClientModel.Primitives.IPersistableModel<'T>)" Usage="System.ClientModel.Primitives.ModelReaderWriter.Read (data, options)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>System.ClientModel.Primitives.IPersistableModel<T></InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="data">The <see cref="T:System.BinaryData" /> to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> into a <typeparamref name="T" />.
</summary>
<returns>A <typeparamref name="T" /> representation of the <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <typeparamref name="T" /> does not have a public or internal parameterless constructor.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="data" /> is null.</exception>
<exception cref="T:System.MissingMethodException">If <typeparamref name="T" /> does not have a public or non public empty constructor.</exception>
</Docs>
</Member>
<Member MemberName="Read<T>">
<MemberSignature Language="C#" Value="public static T? Read<T> (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options, System.ClientModel.Primitives.ModelReaderWriterContext context);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T Read<T>(class System.BinaryData data, class System.ClientModel.Primitives.ModelReaderWriterOptions options, class System.ClientModel.Primitives.ModelReaderWriterContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Read``1(System.BinaryData,System.ClientModel.Primitives.ModelReaderWriterOptions,System.ClientModel.Primitives.ModelReaderWriterContext)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Read(Of T) (data As BinaryData, options As ModelReaderWriterOptions, context As ModelReaderWriterContext) As T" />
<MemberSignature Language="F#" Value="static member Read : BinaryData * System.ClientModel.Primitives.ModelReaderWriterOptions * System.ClientModel.Primitives.ModelReaderWriterContext -> 'T" Usage="System.ClientModel.Primitives.ModelReaderWriter.Read (data, options, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
<Parameter Name="context" Type="System.ClientModel.Primitives.ModelReaderWriterContext" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="data">The <see cref="T:System.BinaryData" /> to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<param name="context"> The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterContext" /> to use.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> into a <typeparamref name="T" />.
</summary>
<returns>A <typeparamref name="T" /> representation of the <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <typeparamref name="T" /> does not have a public or internal parameterless constructor.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="data" /> is null.</exception>
<exception cref="T:System.MissingMethodException">If <typeparamref name="T" /> does not have a public or non public empty constructor.</exception>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public static BinaryData Write (object model, System.ClientModel.Primitives.ModelReaderWriterOptions? options = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.BinaryData Write(object model, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Write(System.Object,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Write (model As Object, Optional options As ModelReaderWriterOptions = Nothing) As BinaryData" />
<MemberSignature Language="F#" Value="static member Write : obj * System.ClientModel.Primitives.ModelReaderWriterOptions -> BinaryData" Usage="System.ClientModel.Primitives.ModelReaderWriter.Write (model, options)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="model" Type="System.Object" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<param name="model">The model to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Converts the value of a model into a <see cref="T:System.BinaryData" />.
</summary>
<returns>A <see cref="T:System.BinaryData" /> representation of the model in the <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" /> specified by the <paramref name="options" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <paramref name="model" /> does not implement <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" />.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="model" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public static BinaryData Write (object model, System.ClientModel.Primitives.ModelReaderWriterOptions options, System.ClientModel.Primitives.ModelReaderWriterContext context);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.BinaryData Write(object model, class System.ClientModel.Primitives.ModelReaderWriterOptions options, class System.ClientModel.Primitives.ModelReaderWriterContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Write(System.Object,System.ClientModel.Primitives.ModelReaderWriterOptions,System.ClientModel.Primitives.ModelReaderWriterContext)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Write (model As Object, options As ModelReaderWriterOptions, context As ModelReaderWriterContext) As BinaryData" />
<MemberSignature Language="F#" Value="static member Write : obj * System.ClientModel.Primitives.ModelReaderWriterOptions * System.ClientModel.Primitives.ModelReaderWriterContext -> BinaryData" Usage="System.ClientModel.Primitives.ModelReaderWriter.Write (model, options, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="model" Type="System.Object" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
<Parameter Name="context" Type="System.ClientModel.Primitives.ModelReaderWriterContext" />
</Parameters>
<Docs>
<param name="model">The model to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<param name="context"> The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterContext" /> to use.</param>
<summary>
Converts the value of a model into a <see cref="T:System.BinaryData" />.
</summary>
<returns>A <see cref="T:System.BinaryData" /> representation of the model in the <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" /> specified by the <paramref name="options" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Throws if <paramref name="model" /> does not implement <see cref="T:System.ClientModel.Primitives.IPersistableModel`1" />.</exception>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="model" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Write<T>">
<MemberSignature Language="C#" Value="public static BinaryData Write<T> (T model, System.ClientModel.Primitives.ModelReaderWriterOptions? options = default) where T : System.ClientModel.Primitives.IPersistableModel<T>;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.BinaryData Write<(class System.ClientModel.Primitives.IPersistableModel`1<!!T>) T>(!!T model, class System.ClientModel.Primitives.ModelReaderWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Write``1(``0,System.ClientModel.Primitives.ModelReaderWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Write(Of T As IPersistableModel(Of T)) (model As T, Optional options As ModelReaderWriterOptions = Nothing) As BinaryData" />
<MemberSignature Language="F#" Value="static member Write : 'T * System.ClientModel.Primitives.ModelReaderWriterOptions -> BinaryData (requires 'T :> System.ClientModel.Primitives.IPersistableModel<'T>)" Usage="System.ClientModel.Primitives.ModelReaderWriter.Write (model, options)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>System.ClientModel.Primitives.IPersistableModel<T></InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="model" Type="T" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
</Parameters>
<Docs>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="model">The model to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<summary>
Converts the value of a model into a <see cref="T:System.BinaryData" />.
</summary>
<returns>A <see cref="T:System.BinaryData" /> representation of the model in the <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" /> specified by the <paramref name="options" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="model" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Write<T>">
<MemberSignature Language="C#" Value="public static BinaryData Write<T> (T model, System.ClientModel.Primitives.ModelReaderWriterOptions options, System.ClientModel.Primitives.ModelReaderWriterContext context);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.BinaryData Write<T>(!!T model, class System.ClientModel.Primitives.ModelReaderWriterOptions options, class System.ClientModel.Primitives.ModelReaderWriterContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ModelReaderWriter.Write``1(``0,System.ClientModel.Primitives.ModelReaderWriterOptions,System.ClientModel.Primitives.ModelReaderWriterContext)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Write(Of T) (model As T, options As ModelReaderWriterOptions, context As ModelReaderWriterContext) As BinaryData" />
<MemberSignature Language="F#" Value="static member Write : 'T * System.ClientModel.Primitives.ModelReaderWriterOptions * System.ClientModel.Primitives.ModelReaderWriterContext -> BinaryData" Usage="System.ClientModel.Primitives.ModelReaderWriter.Write (model, options, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="model" Type="T" />
<Parameter Name="options" Type="System.ClientModel.Primitives.ModelReaderWriterOptions" />
<Parameter Name="context" Type="System.ClientModel.Primitives.ModelReaderWriterContext" />
</Parameters>
<Docs>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="model">The model to convert.</param>
<param name="options">The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterOptions" /> to use.</param>
<param name="context"> The <see cref="T:System.ClientModel.Primitives.ModelReaderWriterContext" /> to use.</param>
<summary>
Converts the value of a model into a <see cref="T:System.BinaryData" />.
</summary>
<returns>A <see cref="T:System.BinaryData" /> representation of the model in the <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" /> specified by the <paramref name="options" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.FormatException">If the model does not support the requested <see cref="P:System.ClientModel.Primitives.ModelReaderWriterOptions.Format" />.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="model" /> is null.</exception>
</Docs>
</Member>
</Members>
</Type>