Proxfield.Text.Ini 1.0.0

The Ini/Config/Conf reader library is a lightweight .ini file parser for DotNet.

Nuget

PM> Install-Package Proxfield.Text.Ini

Visit out project at the Nuget Repository Page to know more.

How

The Ini files are commom type of document used to store key par values into section, it has wide adoption on confguration files, such as the example:

; this is just a comentary
[owner]
name = John Doe
organization = Acme Widgets Inc.

On the case above, the owner is a section. A section is composed of one or more key-par value, in this case name and organization.

Complex objects are handled in a tree format way, everytime a section (or object) has inside of it another section (object) it is displayed as object.propertyObject format.

var user = new User(){
    Email = "jose@outlook.com",
    Password = "1234",
    Name = "Jose",
    UserName = "jose",
    Address = new Address()
    {
        City = "Sao Paulo",
        State = "Sao Paulo",
        Street = "St 10"
    }
}

We can see that the Address object becames the section User.Address, because it is inside the object User.

[User]
UserId=cd1093f4-395d-460a-b66c-0b62af0e3d17
Name=Jose
Email=jose@outlook.com
Password=1234
UserName=jose
[User.Address]
Street=St 10
City=Sao Paulo
State=Sao Paulo

Usage

Serializing object:

string iniContent = IniSerializer.SerializeObject<User>(user);

Deserializing object:

var user = IniSerializer.DeserializeObject<User>(iniContent);

Platform Support

Porxfield.Text.Ini is compiled for DotNet 6, soon there will versions available for other plataforms.

• DotNet 6
• DotNet 5

License

The MIT License (MIT)

Copyright (c) 2022 Proxfield

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.