Configuration.Ini 0.1.3

INI configuration file

Simple INI parser and printer.

Getting started

Use the global using directive for the whole project:

global using Configuration;
global using static Configuration.Prelude;

Or the using directive in a single file:

using Configuration;
using static Configuration.Prelude;

Call Ini function. Pass the IEqualityComparer<string> that will be used to determine equality of keys in the configuration:

Result<Ini, string> result = Ini(new FileInfo("Configuration.ini"));
Result<Ini, string> result = Ini(new FileInfo("Configuration.ini"), StringComparer.OrdinalIgnoreCase);

Use Match() function to extract configuration:

Ini ini = result.Match(ini => ini, err => throw new ApplicationException(err));

Initial Configuration.ini content:

[section_one]

# Comment

KeyOne = SectionOne_ValueOne
KeyTwo = SectionOne_ValueTwo

[section_two]

KeyOne = SectionTwo_ValueOne
KeyTwo = SectionTwo_ValueTwo
KeyThree = SectionTwo_ValueThree

[section_three]

KeyOne = SectionThree_ValueOne
KeyTwo = SectionThree_ValueTwo

Get value associated with the section/key combination:

Option<string> one_one     = ini["section_one", "KeyOne"];
Option<string> two_two     = ini["section_two", "KeyTwo"];
Option<string> three_three = ini["section_three", "KeyThree"];

Console.WriteLine(one_one);     // Some(SectionOne_ValueOne)
Console.WriteLine(two_two);     // Some(SectionTwo_ValueTwo)
Console.WriteLine(three_three); // None

Use IsSome and IsNone properties to check, if value exists:

bool one_one_is_some     = one_one.IsSome;     // true
bool three_three_is_some = three_three.IsSome; // false
bool three_three_is_none = three_three.IsNone; // true

Use Match() function, to extract value:

string one_one_value     = one_one.Match(some => some, "none");     // "SectionOne_ValueOne"
string three_three_value = three_three.Match(some => some, "none"); // "none"

Set Some() to edit value:

ini["section_one", "KeyOne"] = Some("SectionOne_ValueOne_Edited");

one_one = ini["section_one", "KeyOne"];

one_one_value = one_one.Match(some => some, "none"); // "SectionOne_ValueOne_Edited"

Set Some() to add value:

ini["section_one", "KeyThree"] = Some("SectionOne_ValueThree_Added");

Option<string> one_three = ini["section_one", "KeyThree"];

string one_three_value = one_three.Match(some => some, "none"); // "SectionOne_ValueThree_Added"

Set None to remove value:

ini["section_two", "KeyThree"] = None;

Option<string> two_three = ini["section_two", "KeyThree"];

string two_three_value = two_three.Match(some => some, "none"); // "none"

Set None to remove section:

ini["section_three"] = None;

Option<Section> three = ini["section_three"];

bool three_is_none = three.IsNone; // true

Write configuration to a file:

ini.WriteTo(new FileInfo("Configuration.ini"));

Final Configuration.ini content:

[section_one]

KeyOne   = SectionOne_ValueOne_Edited
KeyTwo   = SectionOne_ValueTwo
KeyThree = SectionOne_ValueThree_Added

[section_two]

KeyOne = SectionTwo_ValueOne
KeyTwo = SectionTwo_ValueTwo

Sample

See GettingStarted test.