Configuration.Ini 0.1.9

INI configuration file

Simple INI parser and writer.

Getting started

Use global using directive for the whole project:

global using Functional;
global using Configuration;
global using static Functional.Prelude;
global using static Configuration.Prelude;

Or using directive in the single file:

using Functional;
using Configuration;
using static Functional.Prelude;
using static Configuration.Prelude;

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

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 the configuration:

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

Use Item[section] property to get a section:

Option<Section> one = ini["section_one"];
Option<Section> four = ini["section_four"];

bool oneIsSome = one.IsSome;
bool fourIsNone = four.IsNone;

Assert.True(oneIsSome);
Assert.True(fourIsNone);

Use Item[section, key] property to get a value:

Option<string> oneOne = ini["section_one", "KeyOne"];
Option<string> twoTwo = ini["section_two", "KeyTwo"];
Option<string> threeThree = ini["section_three", "KeyThree"];

Assert.Equal("Some(SectionOne_ValueOne)", oneOne.ToString());
Assert.Equal("Some(SectionTwo_ValueTwo)", twoTwo.ToString());
Assert.Equal("None", threeThree.ToString());

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

bool oneOneIsSome = oneOne.IsSome;
bool threeThreeIsSome = threeThree.IsSome;
bool threeThreeIsNone = threeThree.IsNone;

Assert.True(oneOneIsSome);
Assert.False(threeThreeIsSome);
Assert.True(threeThreeIsNone);

Call Match() function to extract the value, if exists:

string oneOneValue = oneOne.Match(some => some, "none");
string threeThreeValue = threeThree.Match(some => some, "none");

Assert.Equal("SectionOne_ValueOne", oneOneValue);
Assert.Equal("none", threeThreeValue);

Set Some(value) to change the value:

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

Option<string> oneOneChanged = ini["section_one", "KeyOne"];

string oneOneChangedValue = oneOneChanged.Match(some => some, "none");

Assert.Equal("SectionOne_ValueOne_Changed", oneOneChangedValue);

Set Some(value) to add new value:

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

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

string oneThreeAddedValue = oneThreeAdded.Match(some => some, "none");

Assert.Equal("SectionOne_ValueThree_Added", oneThreeAddedValue);

Set None to remove the value:

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

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

string twoThreeValue = twoThree.Match(some => some, "none");

Assert.Equal("none", twoThreeValue);

Set None to remove the section:

ini["section_three"] = None;

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

bool threeIsNone = three.IsNone;

Assert.True(threeIsNone);

Write configuration to the file:

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

Final Configuration.ini content:

[section_one]

KeyOne   = SectionOne_ValueOne_Changed
KeyTwo   = SectionOne_ValueTwo
KeyThree = SectionOne_ValueThree_Added

[section_two]

KeyOne = SectionTwo_ValueOne
KeyTwo = SectionTwo_ValueTwo

Sample

See GettingStarted test.