Migrating to docfx

Docs/api/CapyKit.Helpers.CompressionHelper.yml

@@ -0,0 +1,569 @@
+### YamlMime:ManagedReference
+items:
+- uid: CapyKit.Helpers.CompressionHelper
+  commentId: T:CapyKit.Helpers.CompressionHelper
+  id: CompressionHelper
+  parent: CapyKit.Helpers
+  children:
+  - CapyKit.Helpers.CompressionHelper.Compress(System.Object)
+  - CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
+  - CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
+  - CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
+  - CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
+  langs:
+  - csharp
+  - vb
+  name: CompressionHelper
+  nameWithType: CompressionHelper
+  fullName: CapyKit.Helpers.CompressionHelper
+  type: Class
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: CompressionHelper
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 10
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: A class that contains methods for managing data compression.
+  example: []
+  syntax:
+    content: public static class CompressionHelper
+    content.vb: Public Module CompressionHelper
+  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.CompressionHelper.Compress(System.Object)
+  commentId: M:CapyKit.Helpers.CompressionHelper.Compress(System.Object)
+  id: Compress(System.Object)
+  parent: CapyKit.Helpers.CompressionHelper
+  langs:
+  - csharp
+  - vb
+  name: Compress(object)
+  nameWithType: CompressionHelper.Compress(object)
+  fullName: CapyKit.Helpers.CompressionHelper.Compress(object)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Compress
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 23
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Compresses a given object using the <code>gzip</code> algorithm.
+  example: []
+  syntax:
+    content: public static byte[] Compress(object obj)
+    parameters:
+    - id: obj
+      type: System.Object
+      description: The object.
+    return:
+      type: System.Byte[]
+      description: A byte array representing the compressed object in <code>gzip</code> format.
+    content.vb: Public Shared Function Compress(obj As Object) As Byte()
+  overload: CapyKit.Helpers.CompressionHelper.Compress*
+  nameWithType.vb: CompressionHelper.Compress(Object)
+  fullName.vb: CapyKit.Helpers.CompressionHelper.Compress(Object)
+  name.vb: Compress(Object)
+- uid: CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
+  commentId: M:CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
+  id: CompressToString(System.Object)
+  parent: CapyKit.Helpers.CompressionHelper
+  langs:
+  - csharp
+  - vb
+  name: CompressToString(object)
+  nameWithType: CompressionHelper.CompressToString(object)
+  fullName: CapyKit.Helpers.CompressionHelper.CompressToString(object)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: CompressToString
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 51
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.
+  example: []
+  syntax:
+    content: public static string CompressToString(object obj)
+    parameters:
+    - id: obj
+      type: System.Object
+      description: The object.
+    return:
+      type: System.String
+      description: A string in <code>base64</code> encoding.
+    content.vb: Public Shared Function CompressToString(obj As Object) As String
+  overload: CapyKit.Helpers.CompressionHelper.CompressToString*
+  nameWithType.vb: CompressionHelper.CompressToString(Object)
+  fullName.vb: CapyKit.Helpers.CompressionHelper.CompressToString(Object)
+  name.vb: CompressToString(Object)
+- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
+  commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
+  id: Decompress``1(System.String)
+  parent: CapyKit.Helpers.CompressionHelper
+  langs:
+  - csharp
+  - vb
+  name: Decompress<T>(string)
+  nameWithType: CompressionHelper.Decompress<T>(string)
+  fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(string)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Decompress
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 61
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.
+  example: []
+  syntax:
+    content: public static T Decompress<T>(string encodedString)
+    parameters:
+    - id: encodedString
+      type: System.String
+      description: The <code>base64</code> encoded <code>gzip</code> string.
+    typeParameters:
+    - id: T
+      description: Generic type parameter.
+    return:
+      type: '{T}'
+      description: A <code class="typeparamref">T</code> typed object.
+    content.vb: Public Shared Function Decompress(Of T)(encodedString As String) As T
+  overload: CapyKit.Helpers.CompressionHelper.Decompress*
+  nameWithType.vb: CompressionHelper.Decompress(Of T)(String)
+  fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(String)
+  name.vb: Decompress(Of T)(String)
+- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
+  commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
+  id: Decompress``1(System.Byte[])
+  parent: CapyKit.Helpers.CompressionHelper
+  langs:
+  - csharp
+  - vb
+  name: Decompress<T>(byte[])
+  nameWithType: CompressionHelper.Decompress<T>(byte[])
+  fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(byte[])
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: Decompress
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 71
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Decompresses a given compressed <code>gzip</code> byte stream.
+  example: []
+  syntax:
+    content: public static T Decompress<T>(byte[] byteStream)
+    parameters:
+    - id: byteStream
+      type: System.Byte[]
+      description: The compressed byte stream.
+    typeParameters:
+    - id: T
+      description: Generic type parameter.
+    return:
+      type: '{T}'
+      description: A <code class="typeparamref">T</code> typed object.
+    content.vb: Public Shared Function Decompress(Of T)(byteStream As Byte()) As T
+  overload: CapyKit.Helpers.CompressionHelper.Decompress*
+  nameWithType.vb: CompressionHelper.Decompress(Of T)(Byte())
+  fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(Byte())
+  name.vb: Decompress(Of T)(Byte())
+- uid: CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
+  commentId: M:CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
+  id: DecompressToString(System.String)
+  parent: CapyKit.Helpers.CompressionHelper
+  langs:
+  - csharp
+  - vb
+  name: DecompressToString(string)
+  nameWithType: CompressionHelper.DecompressToString(string)
+  fullName: CapyKit.Helpers.CompressionHelper.DecompressToString(string)
+  type: Method
+  source:
+    remote:
+      path: CapyKit/Helpers/CompressionHelper.cs
+      branch: main
+      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
+    id: DecompressToString
+    path: ../CapyKit/Helpers/CompressionHelper.cs
+    startLine: 96
+  assemblies:
+  - CapyKit
+  namespace: CapyKit.Helpers
+  summary: Decompresses the given <code>base64</code> string in <code>gzip</code> format.
+  example: []
+  syntax:
+    content: public static string DecompressToString(string compressed)
+    parameters:
+    - id: compressed
+      type: System.String
+      description: The compressed string.
+    return:
+      type: System.String
+      description: A decomressed string.
+    content.vb: Public Shared Function DecompressToString(compressed As String) As String
+  overload: CapyKit.Helpers.CompressionHelper.DecompressToString*
+  nameWithType.vb: CompressionHelper.DecompressToString(String)
+  fullName.vb: CapyKit.Helpers.CompressionHelper.DecompressToString(String)
+  name.vb: DecompressToString(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.CompressionHelper.Compress*
+  commentId: Overload:CapyKit.Helpers.CompressionHelper.Compress
+  href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Compress_System_Object_
+  name: Compress
+  nameWithType: CompressionHelper.Compress
+  fullName: CapyKit.Helpers.CompressionHelper.Compress
+- 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.CompressionHelper.CompressToString*
+  commentId: Overload:CapyKit.Helpers.CompressionHelper.CompressToString
+  href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_
+  name: CompressToString
+  nameWithType: CompressionHelper.CompressToString
+  fullName: CapyKit.Helpers.CompressionHelper.CompressToString
+- 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: CapyKit.Helpers.CompressionHelper.Decompress*
+  commentId: Overload:CapyKit.Helpers.CompressionHelper.Decompress
+  href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_
+  name: Decompress
+  nameWithType: CompressionHelper.Decompress
+  fullName: CapyKit.Helpers.CompressionHelper.Decompress
+- uid: '{T}'
+  commentId: '!:T'
+  definition: T
+  name: T
+  nameWithType: T
+  fullName: T
+- uid: T
+  name: T
+  nameWithType: T
+  fullName: T
+- uid: CapyKit.Helpers.CompressionHelper.DecompressToString*
+  commentId: Overload:CapyKit.Helpers.CompressionHelper.DecompressToString
+  href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_
+  name: DecompressToString
+  nameWithType: CompressionHelper.DecompressToString
+  fullName: CapyKit.Helpers.CompressionHelper.DecompressToString