Parse an INI file.
Moduleini-0.5.1Haskell98
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")])]})
Contents
Synopsis
- value readIniFile
- value parseIni
- value lookupValue
- value lookupArray
- value readValue
- value readArray
- value parseValue
- value sections
- value keys
- value printIni
- value writeIniFile
- data KeySeparator
- data WriteIniSettings
- value defaultWriteIniSettings
- value printIniWith
- value writeIniFileWith
- data Ini
- value unIni
- value iniParser
- value sectionParser
- value keyValueParser
- Packageini-0.5.1
- Exports21
- LanguageHaskell98
- LicenceBSD-3-Clause
- SourceIni.hs
Reading
Parse an INI config.
Lookup one value in the config.
Example:
parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= lookupValue "SERVER" "hostname"Right "localhost"
Lookup one value in the config.
Example:
parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= lookupValue "SERVER" "hostname"Right "localhost"
value
readValue Read a value using a reader from Data.Text.Read.
value
readArray Read an array of values using a reader from Data.Text.Read.
Parse a value using a reader from Data.Attoparsec.Text.
Get the sections in the config.
Example:
sections <$> parseIni "[SERVER]\nport: 6667\nhostname: localhost"Right ["SERVER"]
Get the keys in a section.
Example:
parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= keys "SERVER"Right ["hostname","port"]
Writing
Print an INI config.
Print the INI config to a file.
Advanced writing
Either : or =.
Instances4Bounded, Enum, Eq, Show
Bounded KeySeparatorDefined in ini-0.5.1 · Data.IniEnum KeySeparatorDefined in ini-0.5.1 · Data.IniEq KeySeparatorDefined in ini-0.5.1 · Data.IniShow KeySeparatorDefined in ini-0.5.1 · Data.Ini
Settings determining how an INI file is written.
Constructors
Instances1Show
Show WriteIniSettingsDefined in ini-0.5.1 · Data.Ini
The default settings for writing INI files.
Print an INI config.
Print the INI config to a file.
Types
An INI configuration.
Constructors
IniiniSections :: HashMap Text [(Text, Text)]iniGlobals :: [(Text, Text)]
Parsers
Parser for an INI.
A section. Format: [foo]. Conventionally, [FOO].
A key-value pair. Either foo: bar or foo=bar.