quickford 1.1.0

dotnet add package quickford --version 1.1.0                
NuGet\Install-Package quickford -Version 1.1.0                
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="quickford" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add quickford --version 1.1.0                
#r "nuget: quickford, 1.1.0"                
#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 quickford as a Cake Addin
#addin nuget:?package=quickford&version=1.1.0

// Install quickford as a Cake Tool
#tool nuget:?package=quickford&version=1.1.0                

quickford

Base32 encoding for 64-bit values.

Crockford Base32 Encoding is most commonly used to make numeric identifiers slightly more user-resistant. Similar to Hashids, the purpose here is to make the identifiers shorter and less confusing. Unlike Hashids, Crockford Base32 does nothing to conceal the real value of the number (beyond the actual encoding, anyway) and the fact that they are sequential is still pretty obvious when you see consecutive identifiers side by side.

This library does not support encoding and decoding of arbitrary data. Additionally, the spec supports the idea of check digits, but this library currently does not.

The primary purpose of this library is to provide high performance, user-resistant encoding of numeric identifiers. To that end, both encoding and decoding are, in fact, pretty darn fast--an average of eight times faster than the most popular alternative on nuget.org. Additionally, no initialization is required; all methods are static. (And I mean static. There is no lazy initialization nonsense here!)

This library is a port of crockford for Rust.

Usage

Encoding

Encoding is a one-step process.

var x = Base32.Encode(5111);
Assert.Equal("4ZQ", x);

If you want lowercase, then... Well, tough. However, we do now support encoding to a buffer of your choice rather than a new one created in the function. Read on to learn about plan B...

Alternate encoding

var buffer = new StringBuilder();
Base32.Encode(5111, buffer);
Assert.Equal("4ZQ", buffer.ToString());

...This will allow you to avoid additional allocations associated with creating a new stringbuilder on each call to Encode(). The call to ToString() is unavoidable.

Decoding

Decoding is a two-step process. This is because you can feed any string to the decoder, and the decoder will return an error if you try to convince it that "Hello, world!" is a number. (Hint: it isn't.)

var x = Base32.Decode("4zq");
var y = Base32.Decode("4ZQ");

Assert.Equal(5111, x.Value);
Assert.Equal(5111, y.Value);

So, step one is to call the decode function. Step two is to match/verify/unwrap/throw away the output.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Product 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 was computed.  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. 
.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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

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
1.1.0 4,087 5/18/2018
1.0.1 988 2/7/2018
1.0.0 834 2/7/2018
1.0.0-rc 935 1/8/2018

Add TryDecode method.