Changes in 1.2.13.5.

- Made ZlibStatus internal.
- Replaced Checks static class with:
  - ZlibEncoder and ZlibDecoder extension classes.
- Made ZlibEncoder and ZlibDecoder constructors internal.
- Made ZlibEncoder and ZlibDecoder into classes.
- The ZlibEncoder and ZlibDecoder classes now contain a ComputeHash method.
- The properties of ZlibEncoder and ZlibDecoder are now simplified to provide an Options property that contains all the options for the encoder/decoder.
- A new ZlibOptions class which contains all the options for the encoder/decoder.
- The ZlibResult class's Status property is now of type OperationStatus.
- The ZlibResult class's Crc32 and Adler32 properties have been combined into a single hash property.

Author: AraHaan

.github/workflows/dotnet-publish.yml

@@ -25,8 +25,8 @@ jobs:
     - name: Install latest .NET SDK
       uses: Elskom/setup-latest-dotnet@main
       with:
-        SDK_VERSION: '7.0.100'
-        RUNTIME_VERSIONS: '6.0.x'
+        SDK_VERSION: '9.0.100'
+        RUNTIME_VERSIONS: '8.0.x'
 
     - name: Restore, Build, Test, Pack, and Push.
       uses: Elskom/build-dotnet@main

.github/workflows/dotnet.yml

@@ -25,8 +25,8 @@ jobs:
     - name: Install latest .NET SDK
       uses: Elskom/setup-latest-dotnet@main
       with:
-        SDK_VERSION: '7.0.100'
-        RUNTIME_VERSIONS: '6.0.x'
+        SDK_VERSION: '9.0.100'
+        RUNTIME_VERSIONS: '8.0.x'
 
     - name: Restore, Build, Test, and Pack.
       uses: Elskom/build-dotnet@main

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <DebugType>embedded</DebugType>

src/ZlibSharp/Directory.Build.props

@@ -3,17 +3,20 @@
   <Import Project="../../Directory.Build.props" />
 
   <PropertyGroup>
-    <Version>1.2.13.4</Version>
+    <Version>1.2.13.5</Version>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageReleaseNotes>
-      - Made ZlibStatus public.
-      - Replaced MemoryZlib static class with:
-        - Checks inside of a `Checks` static class.
-        - Compression methods inside of a new ZlibEncoder class.*
-        - Decompression methods inside of a new ZlibDecoder class.*
-      - Added Crc32 and Status members to the ZlibResult structure.
-      * The new ZlibEncoder has new TryCompress methods while the new ZlibDecoder has new TryDecompress methods.
+      - Made ZlibStatus internal.
+      - Replaced Checks static class with:
+        - ZlibEncoder and ZlibDecoder extension classes.
+      - Made ZlibEncoder and ZlibDecoder constructors internal.
+      - Made ZlibEncoder and ZlibDecoder into classes.
+      - The ZlibEncoder and ZlibDecoder classes now contain a ComputeHash method.
+      - The properties of ZlibEncoder and ZlibDecoder are now simplified to provide an Options property that contains all the options for the encoder/decoder.
+      - A new ZlibOptions class which contains all the options for the encoder/decoder.
+      - The ZlibResult class's Status property is now of type OperationStatus.
+      - The ZlibResult class's Crc32 and Adler32 properties have been combined into a single hash property.
     </PackageReleaseNotes>
     <Description>
       A high performance .NET zlib wrapper that is span based and offers more functionality over System.IO.Compression by allowing more developer control over how the data is compressed and by avoiding .NET's streams entirely.

src/ZlibSharp/ZlibSharp/Checks.cs

@@ -37,6 +37,7 @@ public NotPackableException(string s, Exception ex)
     /// </summary>
     /// <param name="info">The data for serializing or deserializing the object.</param>
     /// <param name="context">The source and destination for the object.</param>
+    [Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
     private NotPackableException(SerializationInfo info, StreamingContext context)
         : base(info, context)
     {

src/ZlibSharp/ZlibSharp/Exceptions/NotPackableException.cs

@@ -38,6 +38,7 @@ public NotUnpackableException(string s, Exception ex)
     /// </summary>
     /// <param name="info">The data for serializing or deserializing the object.</param>
     /// <param name="context">The source and destination for the object.</param>
+    [Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId = "SYSLIB0051", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")]
     private NotUnpackableException(SerializationInfo info, StreamingContext context)
         : base(info, context)
     {

src/ZlibSharp/ZlibSharp/Exceptions/NotUnpackableException.cs

@@ -0,0 +1,94 @@
+namespace ZlibSharp.Extensions;
+
+using ZlibSharp.Exceptions;
+
+/// <summary>
+/// Extension methods for the <see cref="ZlibDecoder" /> class.
+/// </summary>
+public static class ZlibDecoderExtensions
+{
+    /// <summary>
+    /// Gets the size of the data when it is decompressed. Useful for when the data actually gets decompressed.
+    /// </summary>
+    /// <param name="decoder">The <see cref="ZlibDecoder" /> instance to use.</param>
+    /// <param name="source">The compressed input data.</param>
+    /// <exception cref="NotUnpackableException">
+    /// Thrown when zlib errors internally in any way.
+    /// </exception>
+    /// <returns>The size of the data when it is decompressed.</returns>
+    public static uint GetDecompressedSize(this ZlibDecoder decoder, ReadOnlySpan<byte> source)
+    {
+        var discard = new byte[Array.MaxLength];
+        _ = decoder.TryDecompress(source, discard, out var result);
+        return result.BytesWritten;
+    }
+
+    /// <summary>
+    /// Check data for compression by gzip.
+    /// </summary>
+    /// <param name="_">The <see cref="ZlibDecoder" /> instance to use.</param>
+    /// <param name="source">Input data.</param>
+    /// <returns>Returns <see langword="true" /> if data is compressed by gzip, else <see langword="false" />.</returns>
+    /// <exception cref="ArgumentNullException">When <paramref name="source"/> is <see langword="null" />.</exception>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static bool IsCompressedByGZip(this ZlibDecoder _, ReadOnlySpan<byte> source)
+    {
+        if (source.Length >= 2)
+        {
+            ref var sourceRef = ref MemoryMarshal.GetReference(source);
+            var byte1 = sourceRef;
+            var byte2 = Unsafe.Add(ref sourceRef, 1);
+            return byte1 is 0x1F && byte2 is 0x8B;
+        }
+
+        throw new ArgumentNullException(nameof(source));
+    }
+
+    /// <summary>
+    /// Check data for compression by gzip.
+    /// </summary>
+    /// <param name="decoder">The <see cref="ZlibDecoder" /> instance to use.</param>
+    /// <param name="path">The file to check on if it is compressed by gzip.</param>
+    /// <returns>Returns <see langword="true" /> if data is compressed by gzip, else <see langword="false" />.</returns>
+    /// <exception cref="ArgumentNullException">When <paramref name="path"/> is <see langword="null" /> or <see cref="string.Empty"/>.</exception>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static bool IsCompressedByGZip(this ZlibDecoder decoder, string path)
+        => IsCompressedByGZip(decoder, File.ReadAllBytes(path));
+
+    /// <summary>
+    /// Check data for compression by zlib.
+    /// </summary>
+    /// <param name="_">The <see cref="ZlibDecoder" /> instance to use.</param>
+    /// <param name="source">Input data.</param>
+    /// <returns>Returns <see langword="true" /> if data is compressed by zlib, else <see langword="false" />.</returns>
+    /// <exception cref="ArgumentNullException">When <paramref name="source"/> is <see langword="null" />.</exception>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static bool IsCompressedByZlib(this ZlibDecoder _, ReadOnlySpan<byte> source)
+    {
+        if (source.Length >= 2)
+        {
+            ref var sourceRef = ref MemoryMarshal.GetReference(source);
+            var byte1 = sourceRef;
+            var byte2 = Unsafe.Add(ref sourceRef, 1);
+            return IsZlibHeader(byte1, byte2);
+        }
+
+        throw new ArgumentNullException(nameof(source));
+    }
+
+    /// <summary>
+    /// Check data for compression by zlib.
+    /// </summary>
+    /// <param name="decoder">The <see cref="ZlibDecoder" /> instance to use.</param>
+    /// <param name="path">The file to check on if it is compressed by zlib.</param>
+    /// <returns>Returns <see langword="true" /> if data is compressed by zlib, else <see langword="false" />.</returns>
+    /// <exception cref="ArgumentNullException">When <paramref name="path"/> is <see langword="null" /> or <see cref="string.Empty"/>.</exception>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static bool IsCompressedByZlib(this ZlibDecoder decoder, string path)
+        => IsCompressedByZlib(decoder, File.ReadAllBytes(path));
+
+    [ExcludeFromCodeCoverage]
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private static bool IsZlibHeader(byte byte1, byte byte2)
+        => byte1 is 0x78 && byte2 is 0x01 or 0x5E or 0x9C or 0xDA;
+}

src/ZlibSharp/ZlibSharp/Extensions/ZlibDecoderExtensions.cs

@@ -0,0 +1,26 @@
+namespace ZlibSharp.Extensions;
+
+using ZlibSharp.Exceptions;
+
+/// <summary>
+/// Extension methods for the <see cref="ZlibEncoder" /> class.
+/// </summary>
+public static class ZlibEncoderExtensions
+{
+    /// <summary>
+    /// Gets the size of the data when it is compressed. Useful for when the data actually gets compressed.
+    /// </summary>
+    /// <param name="encoder">The <see cref="ZlibEncoder" /> instance to use.</param>
+    /// <param name="source">The input data buffer.</param>
+    /// <exception cref="NotPackableException">
+    /// Thrown when zlib errors internally in any way.
+    /// </exception>
+    /// <returns>The size of the data when it is compressed.</returns>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public static uint GetCompressedSize(this ZlibEncoder encoder, ReadOnlySpan<byte> source)
+    {
+        var discard = new byte[source.Length];
+        _ = encoder.TryCompress(source, discard, out var result);
+        return result.BytesWritten;
+    }
+}