Moduleini-0.4.2Haskell98

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:

Example1 expression

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

3 types
18 values

Packageini-0.4.2
Exports21
LanguageHaskell98
LicenceBSD-3-Clause
SourceIni.hs

Reading

9 declarations

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

Parse an INI file.

valueparseIni :: Text -> Either String Ini

Parse an INI config.

valuelookupValue

:: Text
Section name
-> Text
Key
-> Ini
-> Either String Text

Lookup one value in the config.

Example:

Example1 expression

>>> parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= lookupValue "SERVER" "hostname"Right "localhost"

valuelookupArray

:: Text
Section name
-> Text
Key
-> Ini
-> Either String [Text]

Lookup one value in the config.

Example:

Example1 expression

>>> parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= lookupValue "SERVER" "hostname"Right "localhost"

valuereadValue

:: Text
Section name
-> Text
Key
-> (Text -> Either String (a, Text))
-> Ini
-> Either String a

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

valuereadArray

:: Text
Section name
-> Text
Key
-> (Text -> Either String (a, Text))
-> Ini
-> Either String [a]

Read an array of values using a reader from Data.Text.Read.

valueparseValue

:: Text
Section name
-> Text
Key
-> Parser a
-> Ini
-> Either String a

Parse a value using a reader from Data.Attoparsec.Text.

valuesections :: Ini -> [Text]

Get the sections in the config.

Example:

Example1 expression

>>> sections <$> parseIni "[SERVER]\nport: 6667\nhostname: localhost"Right ["SERVER"]

valuekeys

:: Text
Section name
-> Ini
-> Either String [Text]

Get the keys in a section.

Example:

Example1 expression

>>> parseIni "[SERVER]\nport: 6667\nhostname: localhost" >>= keys "SERVER"Right ["hostname","port"]

Writing

2 declarations

valueprintIni :: Ini -> Text

Print an INI config.

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

Print the INI config to a file.

Advanced writing

5 declarations

datadata KeySeparator

Either : or =.

ColonKeySeparator EqualsKeySeparator

Instances2Eq, Show

Eq KeySeparatorDefined in ini-0.4.2 · Data.Ini
Show KeySeparatorDefined in ini-0.4.2 · Data.Ini

datadata WriteIniSettings

Settings determining how an INI file is written.

Constructors

WriteIniSettings
- writeIniKeySeparator :: KeySeparator

Instances1Show

Show WriteIniSettingsDefined in ini-0.4.2 · Data.Ini

valuedefaultWriteIniSettings :: WriteIniSettings

The default settings for writing INI files.

valueprintIniWith :: WriteIniSettings -> Ini -> Text

Print an INI config.

valuewriteIniFileWith :: WriteIniSettings -> FilePath -> Ini -> IO ()

Print the INI config to a file.

Types

2 declarations

datadata Ini

An INI configuration.

Constructors

Ini
- iniSections :: HashMap Text [(Text, Text)]
- iniGlobals :: [(Text, Text)]

Instances4Eq, Show, Semigroup, Monoid

Eq IniDefined in ini-0.4.2 · Data.Ini
Show IniDefined in ini-0.4.2 · Data.Ini
Semigroup IniDefined in ini-0.4.2 · Data.Ini
Monoid IniDefined in ini-0.4.2 · Data.Ini

valueunIni :: Ini -> HashMap Text (HashMap Text Text)

Parsers

3 declarations

valueiniParser :: Parser Ini

Parser for an INI.

valuesectionParser :: Parser (Text, [(Text, Text)])

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

valuekeyValueParser :: Parser (Text, Text)

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