Gapotchenko.FX.Data.Encoding.Base16 2022.2.7

Overview

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

Quick Start

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

using Gapotchenko.FX.Data.Encoding;

var encodedText = Base16.GetString(data);

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

var decodedData = Base16.GetBytes(encodedText);

Iterative Data Processing

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

var encoding = Base16.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 = Base16.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 Base16 Algorithms

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

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

Custom Base16 Algorithms

Once in a while, you may encounter a custom Base16 algorithm that is neither widely known nor characterized. In that case, you can instantiate a custom data encoding algorithm with the desired parameters by hand:

var encoding = new CustomBase16(...);

If you want to formalize a custom algorithm even further, you may opt-in to creating a separate class for it with a convenient accessor property:

/// <summary>
/// Defines a custom Base16 data encoding algorithm.
/// </summary>
sealed class FooBase16 : CustomBase16
{
    FooBase16() :
        base(...)
    {
    }

    public static FooBase16 Instance { get; } = new FooBase16();
}

That will allow you to use the algorithm effortlessly from several places in the codebase later:

var encodedText = FooBase16.Instance.GetString(...);

Commonly Used Types

• Gapotchenko.FX.Data.Encoding.Base16

Other Modules

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

• Gapotchenko.FX
• Gapotchenko.FX.AppModel.Information
• Gapotchenko.FX.Collections
• Gapotchenko.FX.Console
• Gapotchenko.FX.Data
  • Gapotchenko.FX.Data.Encoding
    • ➴ Gapotchenko.FX.Data.Encoding.Base16
    • Gapotchenko.FX.Data.Encoding.Base24
    • Gapotchenko.FX.Data.Encoding.Base32
    • Gapotchenko.FX.Data.Encoding.Base64
  • Gapotchenko.FX.Data.Integrity.Checksum
• Gapotchenko.FX.Diagnostics
• Gapotchenko.FX.IO
• Gapotchenko.FX.Linq
• Gapotchenko.FX.Math
• Gapotchenko.FX.Memory
• Gapotchenko.FX.Security.Cryptography
• Gapotchenko.FX.Text
• Gapotchenko.FX.Threading

Or look at the full list of modules.