Gapotchenko.FX.Data.Encoding.Base24 2022.2.7

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Gapotchenko.FX.Data.Encoding.Base24 --version 2022.2.7                
NuGet\Install-Package Gapotchenko.FX.Data.Encoding.Base24 -Version 2022.2.7                
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="Gapotchenko.FX.Data.Encoding.Base24" Version="2022.2.7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Gapotchenko.FX.Data.Encoding.Base24 --version 2022.2.7                
#r "nuget: Gapotchenko.FX.Data.Encoding.Base24, 2022.2.7"                
#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 Gapotchenko.FX.Data.Encoding.Base24 as a Cake Addin
#addin nuget:?package=Gapotchenko.FX.Data.Encoding.Base24&version=2022.2.7

// Install Gapotchenko.FX.Data.Encoding.Base24 as a Cake Tool
#tool nuget:?package=Gapotchenko.FX.Data.Encoding.Base24&version=2022.2.7                

Overview

The module provides the implementation of binary-to-text encoding algorithms belonging to Base24 family.

Quick Start

Use the following code to get the textual representation of the specified data in Base24 encoding:

using Gapotchenko.FX.Data.Encoding;

var encodedText = KuonBase24.GetString(data);

To get the data back from the textual representation, use the following method:

var decodedData = KuonBase24.GetBytes(encodedText);

Iterative Data Processing

If you need to encode the data iteratively then the following approach becomes handy:

var encoding = KuonBase24.Instance;

// Create a streaming encoder that iteratively encodes the data and
// writes the encoded text to the specified text writer.
var stream = encoding.CreateEncoder(textWriter);

// Stream the data to encode.
stream.Write(...); // block 1
// ...
stream.Write(...); // block N

// Flush the data to the underlying text writer.
stream.Flush();

The same approach is valid for the decoding operation which is the opposite of the encoding:

var encoding = KuonBase24.Instance;

// Create a streaming decoder that iteratively reads the encoded text
// from the specified text reader and decodes the data on the fly.
var stream = encoding.CreateDecoder(textReader);

// Stream the decoded data.
stream.Read(...); // block 1
// ...
stream.Read(...); // block N

Available Base24 Algorithms

Base24 family of binary-to-text data encodings consists of the following algorithms with predefined parameters:

Algorithm Gapotchenko.FX Implementation Alphabet Case-Sensitivity Data Encoding Efficiency*
Kuon Base24 KuonBase24 ZAC2B3EF4GH5TK67P8RS9WXY No 0.571

* Data encoding efficiency is the ratio between the amount of original data and its encoded representation.

Commonly Used Types

  • Gapotchenko.FX.Data.Encoding.KuonBase24

Other Modules

Let's continue with a look at some other modules provided by Gapotchenko.FX:

Or look at the full list of modules.

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 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 is compatible.  netcoreapp2.1 is compatible.  netcoreapp2.2 was computed.  netcoreapp3.0 is compatible.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 is compatible.  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.

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
2024.1.3 73 11/10/2024
2022.2.7 249 5/1/2022
2022.2.5 205 5/1/2022