MagicFileEncoding 2.0.0

Magic File Encoding

The Magic File Encoding lib helps to load and transform simple and closed scope char set text files (like EDIFACT).

Be aware of possible transformation issues if the target encoding is simpler than the source encoding.

It is strongly recommended to write unit tests for your use case to ensure the load and transformation works as expected.

Nuget Package

MagicFileEncoding at nuget.org

Versioning & Breaking Changes

Major.Minor.Patch-Suffix

• Major: Breaking changes
• Minor: New features, but backwards compatible
• Patch: Backwards compatible bug fixes only
• -Suffix (optional): a hyphen followed by a string denoting a pre-release version

See: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning

Usage

Read a text file

var text = FileEncoding.ReadAllText(filePath);
// or 
var text = FileEncoding.ReadAllText(filePath, Encoding.Unicode);

Write a text file

FileEncoding.WriteAllText(tmpFile.Path, text, Encoding.UTF8);

Just detect suitable encoding

var encoding = FileEncoding.GetAcceptableEncoding(filename);

Fallback Encoding

The fallback encoding is ISO-8859-1 (Latin-1) by default but can be changed via optional method argument.

(Because this lib was designed for the german culture space)

Credits

This work is heavily based on the following stack overflow and web articles:<br /> determine-a-strings-encoding-in-c-sharp <br /> check-for-invalid-utf8 <br /> how-to-detect-utf-8-in-plain-c <br /> strip-byte-order-mark-from-string-in-c-sharp <br /> what-is-the-most-common-encoding-of-each-language <br /> utf-bom4