SimpleCsvParser.Core 1.1.0

Simple Csv Parser

A csv parser that is meant to convert csv files into lists of objects.

Features

• Delimited file parsing
• Conversion into usable C# objects
• Binding to headers
• Large file processing

Installation

Package Manager

    Install-Package SimpleCsvParser.Core

.NET CLI

    dotnet add package SimpleCsvParser.Core

Paket CLI

    paket add SimpleCsvParser.Core

Options

Delimiter *(char) = ','

The delimiter the parser should use for each row in the file

Wrapper *(char) = '"'

The wrapper tag that is used if the delimiter exists in the data of the column

AllowDefaults *(bool) = true

Determine if the parser should allow defaults when creating the object

ParseHeaders *(bool) = true

Determine if the parser should handle the first line in the delimited stream as a header

RemoveEmptyEntries *(bool) = false

Determine if the parser should remove empty entries from the list before using them

Examples

Basic Usage

This is shorthand to not worry about creating the stream reader.

    public class TestModel
    {
        [CsvProperty("name")]
        public string Name { get; set; }
        [CsvProperty("type")]
        public TestType Type { get; set; }
        [CsvProperty("cost")]
        public int Cost { get; set; }
        [CsvProperty("id")]
        public int Id { get; set; }
    }

    public enum TestType
    {
        Attachment,
        Effect,
        Spell,
        Structure
    }

    ...
    var list = CsvParser.Parse("test.csv", new CsvStreamOptions() { RemoveEmptyEntries = true });
    // List<TestModel>
    //      { Name = "Claws", Type = TestType.Attachment, Cost = 10, Id = 1 }
    //      { Name = "Double Edge Sword", Type = TestType.Attachment, Cost = 10, Id = 2 }
    //      { Name = "Gauntlet", Type = TestType.Attachment, Cost = 10, Id = 3 }
    //      { Name = "Leather Armour", Type = TestType.Attachment, Cost = 15, Id = 4 }
    //      ...
    ...

test.csv

name,type,cost,id,final
Claws,Attachment,10,"1",
Double Edge Sword,Attachment,10,2,
Gauntlet,Attachment,10,3,"Final, Test"
Leather Armour,Attachment,15,4,
Wings,Attachment,15,5,
Control,Effect,10,6,
,,,,
Ensnare,Effect,15,7,
Healing Spring,Effect,15,8,
Katee's Inferno,Effect,20,9,
Tornado,Effect,25,10,
Destroy Attachment,Spell,10,11,
Fireball,Spell,5,12,
,,,,
Heal,Spell,5,13,
Lightning Bolt,Spell,10,14,
Teleport,Spell,10,15,
Armory,Structure,15,16,
Blacksmith,Structure,15,17,
"""Magma"" Fissure",Structure,15,18,
"Medical,Healing Camp",Structure,15,19,
Spire,Structure,5,20,
,,,,
,,,,

Stream Usage

Basic Usage for stream objects

    using (var reader = new CsvStreamReader<TestModel>(stream))
    {
        foreach (var item in reader.AsEnumerable())
        {
            ... Do stuff with item
        }
    }

Large Data Files

Large data files need to be processed differently because some of them will not be able to be held in memory very easily.

    using (var reader = new CsvStreamReader<LargeModel>("large.csv", new CsvStreamOptions() { ParseHeaders = false }))
    {
        reader.ForEach(x => {
            ... Process each in the foreach
        });
    }

License

SimpleCsvParser.Core is licensed under the Microsoft Public License