LinearTsvParser 1.0.1

Linear TSV Parser

NuGet package

Available at: https://www.nuget.org/packages/LinearTsvParser

To include it in a .NET Core project:

dotnet add package LinearTsvParser

Examples

Reading a .tsv.gz file:

using System.IO;
using System.IO.Compression;
using System.Collections.Generic;
using LinearTsvParser;

public class Example {
    public void ReadTsv() {
        using (var input = File.OpenRead("/tmp/test.tsv.gz"))
        using (var gzip = new GZipStream(input, CompressionMode.Decompress))
        using (var tsvReader = new TsvReader(input)) {
            while(!tsvReader.EndOfStream) {
                List<string> fields = tsvReader.ReadLine();
            }
        }
    }
}

Writing a tsv.gz file:

using System.IO;
using System.IO.Compression;
using System.Collections.Generic;
using LinearTsvParser;

public class Example {
    public void WriteTsv() {
        using (var outfile = File.Create("/tmp/test.tsv.gz"))
        using (var gzip = new GZipStream(outfile, CompressionMode.Compress))
        using (var tsvWriter = new TsvWriter(gzip)) {
            foreach(List<string> fields in data) {
                tsvWriter.WriteLine(fields);
            }
        }
    }
}

The Linear TSV format

• Fields are separated by TAB characters
• Text encoding is UTF-8
• The reader can parse lines with any of these three endings: \n, \r\n, \r
• The writer is restricted to output only the \n character as EOL
• Special characters inside the fields are replaced:
  • Newline ⇒ "\n"
  • Carriage return ⇒ "\r"
  • Tab ⇒ "\t"
  • "\" (backslash) ⇒ "\\"

Benchmark

The benchmark test compares the performace of this library with "native" solutions, which use string replace operations. The solution with string replace (native) uses slightly more memory and is a bit slover than this library (lib). The benchmark test can be found here: BenchTest.cs