Safe Haskell	None
Language	Haskell98

Data.Ini

Contents

Reading
Writing
Advanced writing
Types
Parsers

Description

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")])]})

Synopsis

Reading

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

Parse an INI file.

parseIni :: Text -> Either String Ini #

Parse an INI config.

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

Lookup values in the config.

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

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

parseValue :: Text -> Text -> Parser a -> Ini -> Either String a #

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

sections :: Ini -> [Text] #

Get the sections in the config.

keys :: Text -> Ini -> Either String [Text] #

Get the keys in a section.

Writing

printIni :: Ini -> Text #

Print an INI config.

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

Print the INI config to a file.

Advanced writing

data KeySeparator #

Either : or =.

Constructors

ColonKeySeparator
EqualsKeySeparator

Instances

Eq KeySeparator #
Methods (==) :: KeySeparator -> KeySeparator -> Bool # (/=) :: KeySeparator -> KeySeparator -> Bool #
Show KeySeparator #
Methods showsPrec :: Int -> KeySeparator -> ShowS # show :: KeySeparator -> String # showList :: [KeySeparator] -> ShowS #

data WriteIniSettings #

Settings determining how an INI file is written.

Constructors

WriteIniSettings
Fields writeIniKeySeparator :: KeySeparator

Instances

Show WriteIniSettings #
Methods showsPrec :: Int -> WriteIniSettings -> ShowS # show :: WriteIniSettings -> String # showList :: [WriteIniSettings] -> ShowS #

defaultWriteIniSettings :: WriteIniSettings #

The default settings for writing INI files.

printIniWith :: WriteIniSettings -> Ini -> Text #

Print an INI config.

writeIniFileWith :: WriteIniSettings -> FilePath -> Ini -> IO () #

Print the INI config to a file.

Types

newtype Ini #

An INI configuration.

Constructors

Ini
Fields unIni :: HashMap Text (HashMap Text Text)

Instances

Show Ini #
Methods showsPrec :: Int -> Ini -> ShowS # show :: Ini -> String # showList :: [Ini] -> ShowS #
Monoid Ini #
Methods mempty :: Ini # mappend :: Ini -> Ini -> Ini # mconcat :: [Ini] -> 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.