System.IO.Hashing
9.0.0-preview.6.24327.7
Prefix Reserved
See the version list below for details.
dotnet add package System.IO.Hashing --version 9.0.0-preview.6.24327.7
NuGet\Install-Package System.IO.Hashing -Version 9.0.0-preview.6.24327.7
<PackageReference Include="System.IO.Hashing" Version="9.0.0-preview.6.24327.7" />
paket add System.IO.Hashing --version 9.0.0-preview.6.24327.7
#r "nuget: System.IO.Hashing, 9.0.0-preview.6.24327.7"
// Install System.IO.Hashing as a Cake Addin #addin nuget:?package=System.IO.Hashing&version=9.0.0-preview.6.24327.7&prerelease // Install System.IO.Hashing as a Cake Tool #tool nuget:?package=System.IO.Hashing&version=9.0.0-preview.6.24327.7&prerelease
About
System.IO.Hashing offers a variety of hash code algorithms.
Hash code algorithms are pivotal for generating unique values for objects based on their content, facilitating object comparisons, and detecting content alterations. The namespace encompasses algorithms like CRC-32, CRC-64, xxHash3, xxHash32, xxHash64, and xxHash128, all engineered for swift and efficient hash code generation, with xxHash being an "Extremely fast hash algorithm".
Warning: The hash functions provided by System.IO.Hashing are not suitable for security purposes such as handling passwords or verifying untrusted content. For such security-critical applications, consider using cryptographic hash functions provided by the System.Security.Cryptography namespace.
Key Features
- Variety of hash code algorithms including CRC-32, CRC-64, xxHash3, xxHash32, xxHash64, and xxHash128.
- Implementations of CRC-32 and CRC-64 algorithms, as used in IEEE 802.3, and described in ECMA-182, Annex B respectively.
- Implementations of XxHash32 for generating 32-bit hashes, XxHash3 and XxHash64 for generating 64-bit hashes, and xxHash128 for generating 128-bit hashes.
How to Use
Creating hash codes is straightforward.
Call the Hash
method with the content to be hashed.
Here is a practical example:
using System;
using System.IO.Hashing;
byte[] data = new byte[] { 1, 2, 3, 4 };
byte[] crc32Value = Crc32.Hash(data);
Console.WriteLine($"CRC-32 Hash: {BitConverter.ToString(crc32Value)}");
// CRC-32 Hash: CD-FB-3C-B6
byte[] crc64Value = Crc64.Hash(data);
Console.WriteLine($"CRC-64 Hash: {BitConverter.ToString(crc64Value)}");
// CRC-64 Hash: 58-8D-5A-D4-2A-70-1D-B2
byte[] xxHash3Value = XxHash3.Hash(data);
Console.WriteLine($"XxHash3 Hash: {BitConverter.ToString(xxHash3Value)}");
// XxHash3 Hash: 98-8B-7B-90-33-AC-46-22
byte[] xxHash32Value = XxHash32.Hash(data);
Console.WriteLine($"XxHash32 Hash: {BitConverter.ToString(xxHash32Value)}");
// XxHash32 Hash: FE-96-D1-9C
byte[] xxHash64Value = XxHash64.Hash(data);
Console.WriteLine($"XxHash64 Hash: {BitConverter.ToString(xxHash64Value)}");
// XxHash64 Hash: 54-26-20-E3-A2-A9-2E-D1
byte[] xxHash128Value = XxHash128.Hash(data);
Console.WriteLine($"XxHash128 Hash: {BitConverter.ToString(xxHash128Value)}");
// XxHash128 Hash: 49-A0-48-99-59-7A-35-67-53-76-53-A0-D9-95-5B-86
Main Types
The main types provided by this library are:
System.IO.Hashing.Crc32
System.IO.Hashing.Crc64
System.IO.Hashing.XxHash3
System.IO.Hashing.XxHash32
System.IO.Hashing.XxHash64
System.IO.Hashing.XxHash128
Additional Documentation
Related Packages
Cryptographic services, including secure encryption and decryption of data: System.Security.Cryptography
Feedback & Contributing
System.IO.Hashing is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.2
- System.Buffers (>= 4.5.1)
- System.Memory (>= 4.5.5)
-
.NETStandard 2.0
- System.Buffers (>= 4.5.1)
- System.Memory (>= 4.5.5)
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (123)
Showing the top 5 NuGet packages that depend on System.IO.Hashing:
Package | Downloads |
---|---|
Azure.Storage.Common
This client library enables working with the Microsoft Azure Storage services which include the blob and file services for storing binary and text data, and the queue service for storing messages that may be accessed by a client. For this release see notes - https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/README.md and https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/CHANGELOG.md in addition to the breaking changes https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/BreakingChanges.txt Microsoft Azure Storage quickstarts and tutorials - https://docs.microsoft.com/en-us/azure/storage/ Microsoft Azure Storage REST API Reference - https://docs.microsoft.com/en-us/rest/api/storageservices/ |
|
Yarp.ReverseProxy
Reverse proxy toolkit for building fast proxy servers in .NET using the infrastructure from ASP.NET and .NET |
|
CouchbaseNetClient
The Official Couchbase .NET SDK. |
|
Minio
MinIO .NET SDK for Amazon S3 Compatible Cloud Storage. |
|
Verify
Enables verification of complex models and documents. |
GitHub repositories (48)
Showing the top 5 popular GitHub repositories that depend on System.IO.Hashing:
Repository | Stars |
---|---|
Ryujinx/Ryujinx
Experimental Nintendo Switch Emulator written in C#
|
|
files-community/Files
Building the best file manager for Windows
|
|
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
|
|
dotnet/orleans
Cloud Native application framework for .NET
|
|
microsoft/reverse-proxy
A toolkit for developing high-performance HTTP reverse proxy applications.
|