deniszykov.BaseN 3.1.2

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

// Install deniszykov.BaseN as a Cake Tool
#tool nuget:?package=deniszykov.BaseN&version=3.1.2

dotnet_build

Introduction

This is BaseN encoding library. It provides simple API for converting between binary and BaseN encoded text data.
Also there is an implementation of System.Text.Encoding which provides complex streaming API with it's Convert methods.

(Un)desired feature of this library, any invalid symbols (e.g. line breaks) during decoding are ignored.

Supported encoding alphabets are Base16 aka Hex, Base32, ZBase32, Base64, Base64 Url-safe.

Installation

Install-Package deniszykov.BaseN

Usage

Utility classes
Base64Convert.ToString(bytes);
Base64Convert.ToCharArray(bytes);
Base64Convert.ToBytes(string); // (+ 6 overloads)

// also
// Base64UrlConvert
// Base32Convert
// ZBase32Convert
// HexConvert 

Example

using deniszykov.BaseN;

var bytes = Base64Convert.ToBytes("eg==");
// bytes[0] -> 122

Using BaseNEncoding class

using deniszykov.BaseN;

var encoding = BaseNEncoding.Base64;
var input = "eg==".ToCharArray();
var output = new byte[1024];
var decoder = encoding.GetDecoder();

decoder.Convert(input, 0, input.Length, output, 0, output.Length, flush: true, out var inputUsed, out var outputUsed, out var completed);

// completed -> true
// inputUsed -> 4
// outputUsed -> 1
// output[0] -> 122

There is overload of Convert accepting pointers and Span<T>'s.

Using custom alphabet

using deniszykov.BaseN;

var binHex4Alphabet = new BaseNAlphabet("!\"#$%&'()*+,-012345689@ABCDEFGHIJKLMNPQRSTUVXYZ[`abcdefhijklmpqr".ToCharArray());
var encoding = new BaseNEncoding(binHex4Alphabet, "mac-binhex40");

Performance

Benchmark Code
Benchmark Result

|                                 Method |      Mean | Ratio |    Gen 0 | Allocated |
|--------------------------------------- |----------:|------:|---------:|----------:|
|           System_Memory_Base64ToString |  15.57 ms |  0.32 | 125.0000 |  26.67 MB |
|             BaseN_BaseNDecoder_Convert |  29.00 ms |  0.59 | 125.0000 |  26.67 MB |
|           BaseN_Base64Convert_ToString |  39.60 ms |  0.80 | 230.7692 |  53.33 MB |
|           BaseN_Base32Convert_ToString |  46.40 ms |  0.94 | 181.8182 |     64 MB |
|          System_Convert_ToBase64String |  49.21 ms |  1.00 | 181.8182 |  53.33 MB |
| Wiry_Base32Encoding_Standard_GetString |  96.24 ms |  1.96 | 500.0000 |    128 MB |
|       SimpleBase_Base32_Rfc4648_Encode |  99.23 ms |  2.02 | 166.6667 |     64 MB |
|                  Albireo_Base32_Encode | 150.08 ms |  3.04 | 500.0000 |    128 MB |
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 netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 is compatible.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 is compatible.  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 tizen30 was computed.  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.
  • .NETCoreApp 2.1

    • No dependencies.
  • .NETFramework 4.5

    • No dependencies.
  • .NETFramework 4.6.1

    • No dependencies.
  • .NETStandard 1.6

  • .NETStandard 2.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on deniszykov.BaseN:

Package Downloads
Pluto

Pluto is an application server

Pluto.Formatting

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.2 1,093 2/26/2021
3.1.1 319 1/30/2021
3.1.0 304 1/30/2021
3.0.0 316 1/29/2021