Migrating to docfx

Docs/api/CapyKit.Helpers.SerializationHelper.yml

@@ -0,0 +1,614 @@
+### YamlMime:ManagedReference
+items:
+- uid: CapyKit.Helpers.SerializationHelper
+  commentId: T:CapyKit.Helpers.SerializationHelper
+  id: SerializationHelper
+  parent: CapyKit.Helpers
+  children:
+  - CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
+  - CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
+  - CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
+  - CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
+  - CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
+  langs:
+  - csharp
+  - vb
+  name: SerializationHelper
+  nameWithType: SerializationHelper
+  fullName: CapyKit.Helpers.SerializationHelper
+  type: Class
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: SerializationHelper
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 12
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  syntax:
+    content: public static class SerializationHelper
+    content.vb: Public Module SerializationHelper
+  inheritance:
+  - System.Object
+  inheritedMembers:
+  - System.Object.Equals(System.Object)
+  - System.Object.Equals(System.Object,System.Object)
+  - System.Object.GetHashCode
+  - System.Object.GetType
+  - System.Object.MemberwiseClone
+  - System.Object.ReferenceEquals(System.Object,System.Object)
+  - System.Object.ToString
+- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
+  commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
+  id: SerializeToBytes(System.Object)
+  parent: CapyKit.Helpers.SerializationHelper
+  langs:
+  - csharp
+  - vb
+  name: SerializeToBytes(object)
+  nameWithType: SerializationHelper.SerializeToBytes(object)
+  fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes(object)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: SerializeToBytes
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 25
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Serializes an object to a byte array.
+  example: []
+  syntax:
+    content: public static byte[] SerializeToBytes(object obj)
+    parameters:
+    - id: obj
+      type: System.Object
+      description: The object.
+    return:
+      type: System.Byte[]
+      description: A <code>JSON</code> encoded string.
+    content.vb: Public Shared Function SerializeToBytes(obj As Object) As Byte()
+  overload: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
+  nameWithType.vb: SerializationHelper.SerializeToBytes(Object)
+  fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToBytes(Object)
+  name.vb: SerializeToBytes(Object)
+- uid: CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
+  commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
+  id: SerializeToString(System.Object)
+  parent: CapyKit.Helpers.SerializationHelper
+  langs:
+  - csharp
+  - vb
+  name: SerializeToString(object)
+  nameWithType: SerializationHelper.SerializeToString(object)
+  fullName: CapyKit.Helpers.SerializationHelper.SerializeToString(object)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: SerializeToString
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 33
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Serializes an object to a <code>JSON</code> encoded string.
+  example: []
+  syntax:
+    content: public static string SerializeToString(object obj)
+    parameters:
+    - id: obj
+      type: System.Object
+      description: The object.
+    return:
+      type: System.String
+      description: A <code>JSON</code> encoded string.
+    content.vb: Public Shared Function SerializeToString(obj As Object) As String
+  overload: CapyKit.Helpers.SerializationHelper.SerializeToString*
+  nameWithType.vb: SerializationHelper.SerializeToString(Object)
+  fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToString(Object)
+  name.vb: SerializeToString(Object)
+- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
+  commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
+  id: Deserialize``1(System.Byte[])
+  parent: CapyKit.Helpers.SerializationHelper
+  langs:
+  - csharp
+  - vb
+  name: Deserialize<T>(byte[])
+  nameWithType: SerializationHelper.Deserialize<T>(byte[])
+  fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(byte[])
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Deserialize
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 43
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
+  example: []
+  syntax:
+    content: public static T Deserialize<T>(byte[] bytes)
+    parameters:
+    - id: bytes
+      type: System.Byte[]
+      description: The byte array representing a <code class="typeparamref">T</code> object.
+    typeParameters:
+    - id: T
+      description: Generic type parameter.
+    return:
+      type: '{T}'
+      description: A <code class="typeparamref">T</code> object.
+    content.vb: Public Shared Function Deserialize(Of T)(bytes As Byte()) As T
+  overload: CapyKit.Helpers.SerializationHelper.Deserialize*
+  exceptions:
+  - type: System.FormatException
+    commentId: T:System.FormatException
+    description: Thrown when the format of the byte array is incorrect.
+  nameWithType.vb: SerializationHelper.Deserialize(Of T)(Byte())
+  fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(Byte())
+  name.vb: Deserialize(Of T)(Byte())
+- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
+  commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
+  id: Deserialize``1(System.IO.Stream)
+  parent: CapyKit.Helpers.SerializationHelper
+  langs:
+  - csharp
+  - vb
+  name: Deserialize<T>(Stream)
+  nameWithType: SerializationHelper.Deserialize<T>(Stream)
+  fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(System.IO.Stream)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Deserialize
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 57
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
+  example: []
+  syntax:
+    content: public static T Deserialize<T>(Stream stream)
+    parameters:
+    - id: stream
+      type: System.IO.Stream
+      description: The steam.
+    typeParameters:
+    - id: T
+      description: Generic type parameter.
+    return:
+      type: '{T}'
+      description: A <code class="typeparamref">T</code> object.
+    content.vb: Public Shared Function Deserialize(Of T)(stream As Stream) As T
+  overload: CapyKit.Helpers.SerializationHelper.Deserialize*
+  exceptions:
+  - type: System.FormatException
+    commentId: T:System.FormatException
+    description: Thrown when the format of an input is incorrect.
+  nameWithType.vb: SerializationHelper.Deserialize(Of T)(Stream)
+  fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(System.IO.Stream)
+  name.vb: Deserialize(Of T)(Stream)
+- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
+  commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
+  id: Deserialize``1(System.String)
+  parent: CapyKit.Helpers.SerializationHelper
+  langs:
+  - csharp
+  - vb
+  name: Deserialize<T>(string)
+  nameWithType: SerializationHelper.Deserialize<T>(string)
+  fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(string)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/SerializationHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Deserialize
+    path: ../CapyKit/Helpers/SerializationHelper.cs
+    startLine: 87
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.
+  example: []
+  syntax:
+    content: public static T Deserialize<T>(string str)
+    parameters:
+    - id: str
+      type: System.String
+      description: The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.
+    typeParameters:
+    - id: T
+      description: Generic type parameter.
+    return:
+      type: '{T}'
+      description: A <code class="typeparamref">T</code> object.
+    content.vb: Public Shared Function Deserialize(Of T)(str As String) As T
+  overload: CapyKit.Helpers.SerializationHelper.Deserialize*
+  nameWithType.vb: SerializationHelper.Deserialize(Of T)(String)
+  fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(String)
+  name.vb: Deserialize(Of T)(String)
+references:
+- uid: CapyKit.Helpers
+  commentId: N:CapyKit.Helpers
+  href: CapyKit.html
+  name: CapyKit.Helpers
+  nameWithType: CapyKit.Helpers
+  fullName: CapyKit.Helpers
+  spec.csharp:
+  - uid: CapyKit
+    name: CapyKit
+    href: CapyKit.html
+  - name: .
+  - uid: CapyKit.Helpers
+    name: Helpers
+    href: CapyKit.Helpers.html
+  spec.vb:
+  - uid: CapyKit
+    name: CapyKit
+    href: CapyKit.html
+  - name: .
+  - uid: CapyKit.Helpers
+    name: Helpers
+    href: CapyKit.Helpers.html
+- uid: System.Object
+  commentId: T:System.Object
+  parent: System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object
+  name: object
+  nameWithType: object
+  fullName: object
+  nameWithType.vb: Object
+  fullName.vb: Object
+  name.vb: Object
+- uid: System.Object.Equals(System.Object)
+  commentId: M:System.Object.Equals(System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  name: Equals(object)
+  nameWithType: object.Equals(object)
+  fullName: object.Equals(object)
+  nameWithType.vb: Object.Equals(Object)
+  fullName.vb: Object.Equals(Object)
+  name.vb: Equals(Object)
+  spec.csharp:
+  - uid: System.Object.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.Equals(System.Object,System.Object)
+  commentId: M:System.Object.Equals(System.Object,System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  name: Equals(object, object)
+  nameWithType: object.Equals(object, object)
+  fullName: object.Equals(object, object)
+  nameWithType.vb: Object.Equals(Object, Object)
+  fullName.vb: Object.Equals(Object, Object)
+  name.vb: Equals(Object, Object)
+  spec.csharp:
+  - uid: System.Object.Equals(System.Object,System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.Equals(System.Object,System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.GetHashCode
+  commentId: M:System.Object.GetHashCode
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  name: GetHashCode()
+  nameWithType: object.GetHashCode()
+  fullName: object.GetHashCode()
+  nameWithType.vb: Object.GetHashCode()
+  fullName.vb: Object.GetHashCode()
+  spec.csharp:
+  - uid: System.Object.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  - name: (
+  - name: )
+- uid: System.Object.GetType
+  commentId: M:System.Object.GetType
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  name: GetType()
+  nameWithType: object.GetType()
+  fullName: object.GetType()
+  nameWithType.vb: Object.GetType()
+  fullName.vb: Object.GetType()
+  spec.csharp:
+  - uid: System.Object.GetType
+    name: GetType
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.GetType
+    name: GetType
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  - name: (
+  - name: )
+- uid: System.Object.MemberwiseClone
+  commentId: M:System.Object.MemberwiseClone
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  name: MemberwiseClone()
+  nameWithType: object.MemberwiseClone()
+  fullName: object.MemberwiseClone()
+  nameWithType.vb: Object.MemberwiseClone()
+  fullName.vb: Object.MemberwiseClone()
+  spec.csharp:
+  - uid: System.Object.MemberwiseClone
+    name: MemberwiseClone
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.MemberwiseClone
+    name: MemberwiseClone
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  - name: (
+  - name: )
+- uid: System.Object.ReferenceEquals(System.Object,System.Object)
+  commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  name: ReferenceEquals(object, object)
+  nameWithType: object.ReferenceEquals(object, object)
+  fullName: object.ReferenceEquals(object, object)
+  nameWithType.vb: Object.ReferenceEquals(Object, Object)
+  fullName.vb: Object.ReferenceEquals(Object, Object)
+  name.vb: ReferenceEquals(Object, Object)
+  spec.csharp:
+  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
+    name: ReferenceEquals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
+    name: ReferenceEquals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.ToString
+  commentId: M:System.Object.ToString
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  name: ToString()
+  nameWithType: object.ToString()
+  fullName: object.ToString()
+  nameWithType.vb: Object.ToString()
+  fullName.vb: Object.ToString()
+  spec.csharp:
+  - uid: System.Object.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  - name: (
+  - name: )
+- uid: System
+  commentId: N:System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system
+  name: System
+  nameWithType: System
+  fullName: System
+- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
+  commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToBytes
+  href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_
+  name: SerializeToBytes
+  nameWithType: SerializationHelper.SerializeToBytes
+  fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes
+- uid: System.Byte[]
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.byte
+  name: byte[]
+  nameWithType: byte[]
+  fullName: byte[]
+  nameWithType.vb: Byte()
+  fullName.vb: Byte()
+  name.vb: Byte()
+  spec.csharp:
+  - uid: System.Byte
+    name: byte
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.byte
+  - name: '['
+  - name: ']'
+  spec.vb:
+  - uid: System.Byte
+    name: Byte
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.byte
+  - name: (
+  - name: )
+- uid: CapyKit.Helpers.SerializationHelper.SerializeToString*
+  commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToString
+  href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_
+  name: SerializeToString
+  nameWithType: SerializationHelper.SerializeToString
+  fullName: CapyKit.Helpers.SerializationHelper.SerializeToString
+- uid: System.String
+  commentId: T:System.String
+  parent: System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.string
+  name: string
+  nameWithType: string
+  fullName: string
+  nameWithType.vb: String
+  fullName.vb: String
+  name.vb: String
+- uid: System.FormatException
+  commentId: T:System.FormatException
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.formatexception
+  name: FormatException
+  nameWithType: FormatException
+  fullName: System.FormatException
+- uid: CapyKit.Helpers.SerializationHelper.Deserialize*
+  commentId: Overload:CapyKit.Helpers.SerializationHelper.Deserialize
+  href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___
+  name: Deserialize
+  nameWithType: SerializationHelper.Deserialize
+  fullName: CapyKit.Helpers.SerializationHelper.Deserialize
+- uid: '{T}'
+  commentId: '!:T'
+  definition: T
+  name: T
+  nameWithType: T
+  fullName: T
+- uid: T
+  name: T
+  nameWithType: T
+  fullName: T
+- uid: System.IO.Stream
+  commentId: T:System.IO.Stream
+  parent: System.IO
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.io.stream
+  name: Stream
+  nameWithType: Stream
+  fullName: System.IO.Stream
+- uid: System.IO
+  commentId: N:System.IO
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system
+  name: System.IO
+  nameWithType: System.IO
+  fullName: System.IO
+  spec.csharp:
+  - uid: System
+    name: System
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system
+  - name: .
+  - uid: System.IO
+    name: IO
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.io
+  spec.vb:
+  - uid: System
+    name: System
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system
+  - name: .
+  - uid: System.IO
+    name: IO
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.io