Data.Ini

Clean configuration files in the INI format.

Format rules and recommendations:

• The : syntax is space-sensitive.
• Keys are case-sensitive.
• Lower-case is recommended.
• Values can be empty.
• Keys cannot key separators, section delimiters, or comment markers.
• Comments must start at the beginning of the line and start with ; or #.

An example configuration file:

 # Some comment.
 [SERVER]
 port=6667
 hostname=localhost
 ; another comment here
 [AUTH]
 user: hello
 pass: world
 salt:

Parsing example:

>>> parseIni "[SERVER]\nport: 6667\nhostname: localhost"
Right (Ini {unIni = fromList [("SERVER",fromList [("hostname","localhost"),("port","6667")])]})

Reading

readIniFile :: FilePath -> IO (Either String Ini)

Parse an INI file.

parseIni :: Text -> Either String Ini

Parse an INI config.

lookupValue :: Ini -> Text -> Text -> Either String Text

Lookup values in the config.

readValue :: Ini -> Text -> Text -> (Text -> Either String (a, Text)) -> Either String a

Read a value using a reader from Data.Text.Read.

Writing

writeIniFile :: FilePath -> Ini -> IO ()

Print the INI config to a file.

printIni :: Ini -> Text

Print an INI config.

Types

newtype Ini

An INI configuration.

Constructors

Ini

Fields

unIni :: HashMap Text (HashMap Text Text)

Instances

Show Ini

Parsers

iniParser :: Parser Ini

Parser for an INI.

sectionParser :: Parser (Text, HashMap Text Text)

A section. Format: [foo]. Conventionally, [FOO].

keyValueParser :: Parser (Text, Text)

A key-value pair. Either foo: bar or foo=bar.