GrindCore 0.0.8-alpha

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
This is a prerelease version of GrindCore. 
dotnet add package GrindCore --version 0.0.8-alpha                

                    
                

            
NuGet\Install-Package GrindCore -Version 0.0.8-alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="GrindCore" Version="0.0.8-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add GrindCore --version 0.0.8-alpha                

                    
                

            
#r "nuget: GrindCore, 0.0.8-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install GrindCore as a Cake Addin
#addin nuget:?package=GrindCore&version=0.0.8-alpha&prerelease

// Install GrindCore as a Cake Tool
#tool nuget:?package=GrindCore&version=0.0.8-alpha&prerelease

GrindCore

A compression and Hashing library built the System.IO.Compression way... A managed dotnet wrapper around a Native library (GrindCore Native).

Published to nuget as GrindCore and supports multiple platforms.

Published to nuget as GrindCore

This library is in the early stages of development. There may be many breaking changes over the following months.

Overview

GrindCore is an innovative library designed to streamline and enhance compression processes in dotnet applications. It aims to tackle prevalent issues such as performance degradation and outdated implementations when native code updates frequently. By unifying multiple C forks into a single, multiplatform library, GrindCore achieves a cohesive and efficient solution.

Core Objectives

The primary goal of GrindCore is to deliver a maintainable compression and hashing solution for dotnet applications. Leveraging the exact method used to build C in the dotnet runtime ensures a robust approach. By preserving precise compression algorithms for key versions, GrindCore guarantees compatibility and reliability for projects requiring byte-perfect output.

Current Features

Compression

  • Streams

    • ZLib v1.3.1 (DotNet 8.0) [GZip, ZLib, Deflate]
    • ZLib-NG v2.2.1 (DotNet 9.0) [GZip, ZLib, Deflate]
    • Brotli v1.1.0 (DotNet 9.0)

  • Archives

    • Zip

Hashing

  • Blake3, Blake2sp
  • MD5, MD4, MD2
  • SHA1
  • SHA2 [SHA256, SHA384, SHA512]
  • SHA3 [SHA3-224, SHA3-256, SHA3-384, SHA3-512]
  • XXHash [XXH32, XXH64]

Lots more functionality to be added.

Continuous Integration (CI) Status

A comprehensive list of test statuses for various platforms is available below. For a quick summary: GrindCore is being actively tested across major platforms including Linux ARM64, Linux ARM, Linux x64, macOS x64, macOS ARM64, Windows x64, and Windows x86. Windows ARM64 builds, but there is no test platform available.

Detailed Test Status

Platform Unit Test Status
Linux ARM64 Linux ARM64 Status
Linux ARM Linux ARM Status
Linux x64 Linux x64 Status
macOS x64 macOS x64 Status
macOS ARM64 macOS ARM64 Status
Windows x64 Windows x64 Status
Windows x86 Windows x86 Status
Windows ARM64 Builds, no test platform available

Key Project Integrations

GrindCore integrates robust solutions from several key projects:

  • dotnet Runtime GitHub Repository:
    • Provides a foundation with multiplatform C compilation based on CMake and C, ensuring seamless integration across different platforms.
    • Supplies zlib/deflate and Brotli from the dotnet 8 code, combined with C# wrappers, to offer efficient and reliable compression algorithms.
  • 7zip mcmilk GitHub Repository:
    • Contributes a comprehensive suite of hash functions, including SHA-1, SHA-2, SHA-3, MD2, MD4, MD5, and XXHash (32 and 64). More compression and hashing algorithms will be ported, benefiting from a uniform Make project structure that simplifies integration.
  • SharpCompress GitHub Repository:
    • Expected to provide managed code to process archives and wrap native compression streams, further enhancing the library's capabilities and user experience.

Addressing Current Issues

GrindCore is designed to overcome several known complications in the dotnet ecosystem:

  • Performance:
    • C# ports generally perform slower than native C, although the JIT offers powerful optimization capabilities.
  • Up-to-date Implementations:
    • Leveraging well-maintained projects like dotnet Runtime and 7zip mcmilk ensures that the C algorithms can be updated easily.
  • Cross-Platform Compatibility:
    • Through multiplatform C compilation via the dotnet CMake system, GrindCore ensures seamless functionality across different operating systems. The managed layer abstracts this, allowing it to be used as System.IO.Compression would be used.
  • Consistency:
    • By preserving exact compression algorithms, the library is ideal for projects requiring checksummed output, ensuring consistent data results and reliability.
  • Addressing Missing Functionality:
    • GrindCore aims to expose additional functionalities not available in other libraries, such as compress2 from zlib/deflate, providing more options and flexibility for developers.

Conclusion

GrindCore is on a journey to create a more reliable and efficient compression solution for dotnet. The community's contributions and collaboration are welcomed.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.8-alpha 40 2/10/2025
0.0.7-alpha 27 1/8/2025
0.0.6-alpha 52 12/23/2024
0.0.5-alpha 133 12/17/2024
0.0.4-alpha 50 12/16/2024
0.0.3-alpha 49 12/16/2024
0.0.2-alpha 55 12/16/2024
0.0.1-alpha 53 12/16/2024