{-| Module : Toml Description : TOML parsing, printing, and codecs Copyright : (c) Eric Mertens, 2023 License : ISC Maintainer : emertens@gmail.com This is the high-level interface to the toml-parser library. It enables parsing, printing, and coversion into and out of application-specific representations. This parser implements TOML 1.0.0 as carefully as possible. -} module Toml ( -- * Types Table, Value(..), -- * Parsing parse, -- * Printing prettyToml, DocClass(..), -- * Serialization decode, encode, Result(..), ) where import Toml.FromValue (FromValue (fromValue), Result(..)) import Toml.FromValue.Matcher (runMatcher) import Toml.Parser (parseRawToml) import Toml.Pretty (TomlDoc, DocClass(..), prettyToml, prettySemanticError, prettyMatchMessage, prettyLocated) import Toml.Semantics (semantics) import Toml.ToValue (ToTable (toTable)) import Toml.Value (Table, Value(..)) -- | Parse a TOML formatted 'String' or report an error message. parse :: String -> Either String Table parse str = case parseRawToml str of Left e -> Left (prettyLocated e) Right exprs -> case semantics exprs of Left e -> Left (prettyLocated (prettySemanticError <$> e)) Right tab -> Right tab -- | Use the 'FromValue' instance to decode a value from a TOML string. decode :: FromValue a => String -> Result String a decode str = case parse str of Left e -> Failure [e] Right tab -> case runMatcher (fromValue (Table tab)) of Failure es -> Failure (prettyMatchMessage <$> es) Success ws x -> Success (prettyMatchMessage <$> ws) x -- | Use the 'ToTable' instance to encode a value to a TOML string. encode :: ToTable a => a -> TomlDoc encode = prettyToml . toTable