mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 15:01:52 -05:00
Jordan Wages
735d7c4c91
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
# CompressionHelper Class
|
|
|
|
|
|
A class that contains methods for managing data compression.
|
|
|
|
|
|
|
|
## Definition
|
|
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
|
|
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
|
|
|
|
**C#**
|
|
``` C#
|
|
public static class CompressionHelper
|
|
```
|
|
**VB**
|
|
``` VB
|
|
Public NotInheritable Class CompressionHelper
|
|
```
|
|
**C++**
|
|
``` C++
|
|
public ref class CompressionHelper abstract sealed
|
|
```
|
|
**F#**
|
|
``` F#
|
|
[<AbstractClassAttribute>]
|
|
[<SealedAttribute>]
|
|
type CompressionHelper = class end
|
|
```
|
|
|
|
<table><tr><td><strong>Inheritance</strong></td><td><a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> → CompressionHelper</td></tr>
|
|
</table>
|
|
|
|
|
|
|
|
## Methods
|
|
<table>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Helpers_CompressionHelper_Compress">Compress</a></td>
|
|
<td>Compresses a given object using the <code>gzip</code> algorithm.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Helpers_CompressionHelper_CompressToString">CompressToString</a></td>
|
|
<td>Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Helpers_CompressionHelper_Decompress__1">Decompress(T)(Byte[])</a></td>
|
|
<td>Decompresses a given compressed <code>gzip</code> byte stream.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Helpers_CompressionHelper_Decompress__1_1">Decompress(T)(String)</a></td>
|
|
<td>Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.</td></tr>
|
|
<tr>
|
|
<td><a href="M_CapyKit_Helpers_CompressionHelper_DecompressToString">DecompressToString</a></td>
|
|
<td>Decompresses the given <code>base64</code> string in <code>gzip</code> format.</td></tr>
|
|
</table>
|
|
|
|
## See Also
|
|
|
|
|
|
#### Reference
|
|
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>
|