Library of encoding/decoding related functionality for Hexadecimal, Base64 and Base32.
ByteDev.Encoding has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.
ByteDev.Encoding is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:
Install-Package ByteDev.Encoding
Further details can be found on the nuget page.
Releases follow semantic versioning.
Full details of the release notes can be viewed on GitHub.
The main library classes include:
- Base32Encoder
- Base64Encoder
- HexEncoder
- Serializer
- EncoderFactory
String extension methods:
- IsBase32
- IsBase64
- IsHex
Char extension methods:
- IsBase32
- IsBase64
- IsHex
Base32Encoder
provides a way to encode to base32 strings and decode back again.
IEncoder encoder = new Base32Encoder();
string base32 = encoder.Encode("John");
// base32 == "JJXWQ3Q="
bool isBase32 = base32.IsBase32();
// isBase32 == true
string text = encoder.Decode(base32);
// text == "John"
Base64Encoder
provides a way to encode to base64 strings and decode back again.
IEncoder encoder = new Base64Encoder();
string base64 = encoder.Encode("John");
// base64 == "Sm9obg=="
bool isBase64 = base64.IsBase64();
// isBase64 == true
string text = encoder.Decode(base64);
// text == "John"
HexEncoder
provides a way to encode to hexadecimal strings and decode back again.
IEncoder encoder = new HexEncoder('='); // optional delimiter arg
string hex = encoder.Encode("John");
// hex == "4A=6F=68=6E"
bool isHex = hex.IsHex('=');
// isHex == true
string text = encoder.Decode(hex);
// text == "John"
The Serializer
class provides a way to serialize/deserialize objects based on the provided IEncoder
implementation (Base32, Base64 or Hex).
// Entity to serialize
[Serializable]
public class Person
{
public string Name { get; set; }
}
// ...
var person = new Person { Name = "John Smith" }
// Setup serializer
IEncoder encoder = new Base64Encoder();
ISerializer serializer = new Serializer(encoder);
// Serialize
string base64 = serializer.Serialize(person);
// Deserialize
Person person = serializer.Deserialize<Person>(base64);
The EncoderFactory
provides a convenient way to create a type of encoder based on the EncodingType
.
IEncoderFactory factory = new EncoderFactory();
IEncoder base64Encoder = factory.Create(EncodingType.Base64);