Fini 0.2.0

INI configuration file

An immutable collection of key-value pairs organized in sections, based on the F# Map type.

Getting started

Import Fini namespace:

open Fini

Initial INI file content:

global_key=global_value
[one]
one_key=one_value
[one.two]
two_key=two_value
[three]
three_key=three_value

Call fromFile function to read configuration from a file:

let ini =
    match Ini.fromFile "readme.ini" with
    | Ok ini -> ini
    | Error err -> Ini.empty

Call findGlobal function to get a value from global section:

let value =
    match ini |> Ini.findGlobal "global_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "global_value"

Debug.Assert equal

let value =
    match ini |> Ini.findGlobal "one_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "none"

Debug.Assert equal

Call find function to get a value from a section:

let value =
    match ini |> Ini.find "one" "one_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "one_value"

Debug.Assert equal

let value =
    match ini |> Ini.find "one" "two_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "none"

Debug.Assert equal

Call findNested function to get a value from nested sections:

let value =
    match ini |> Ini.findNested "one.two" "one_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "one_value"

Debug.Assert equal
    
let value =
    match ini |> Ini.findNested "one.two" "two_key" with
    | Some value -> value
    | None -> "none"

let equal = value = "two_value"

Debug.Assert equal

Call add (addGlobal) function to replace a value in a (global) section:

let ini = ini |> Ini.add "three" "three_key" "replaced_three_value"

let value = ini |> Ini.find "three" "three_key"

let equal = (value = Some "replaced_three_value")

Debug.Assert equal

Call add (addGlobal) function to add a value to a (global) section:

let ini = ini |> Ini.add "four" "four_key" "four_value"

let value = ini |> Ini.find "four" "four_key"

let equal = (value = Some "four_value")

Debug.Assert equal

Call remove (removeGlobal) function to remove a value from a (global) section:

let ini = ini |> Ini.remove "one" "one_key"

let value = ini |> Ini.find "one" "one_key"

let equal = (value = None)

Debug.Assert equal

Call toFile function to save configuration to a file:

ini |> Ini.toFile "readme.ini" |> ignore

Final INI file content:

global_key=global_value
[four]
four_key=four_value
[one.two]
two_key=two_value
[three]
three_key=replaced_three_value