-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Parse TOML values produced by htoml-megaparsec package.
--   
--   Package definecs set of parser combinators that allows analyzing
--   arbitrary TOML structures. Includes formatted errors that keep track
--   of where in the original TOML file a value came from.
@package htoml-parse
@version 0.1


module Data.Toml.Parse
data Node
VTable :: Table -> Node
VTArray :: VTArray -> Node
VString :: Text -> Node
VInteger :: Int64 -> Node
VFloat :: Double -> Node
VBoolean :: Bool -> Node
VDatetime :: UTCTime -> Node
VArray :: VArray -> Node
data Parser a
runParser :: a -> (L a -> Parser b) -> Either (Doc Void) b
mkTomlError :: L a -> Doc Void -> TomlError
data AtomicTomlError
UnexpectedType :: !TomlType -> Node -> AtomicTomlError
MissingKey :: !Text -> Table -> AtomicTomlError
IndexOutOfBounds :: !Int -> Node -> AtomicTomlError
OtherError :: Doc Void -> AtomicTomlError
data TomlError

-- | Add textual annotation to the provided located thing. The annotation
--   will be shows as part of error message if the location ultimately gets
--   passed to <a>throwParseError</a>.
(<?>) :: L a -> Text -> L a
infixl 9 <?>

-- | Adds to <tt>a</tt> its provenance in the toml file.
data L a

-- | <pre>
--   <a>extract</a> . <a>fmap</a> f = f . <a>extract</a>
--   </pre>
extract :: Comonad w => w a -> a
class (Applicative m, Alternative m) => TomlParse m
throwParseError :: TomlParse m => L b -> AtomicTomlError -> m a
class FromToml a b
fromToml :: FromToml a b => L a -> Parser b
class Index a
(.:) :: (Index a, FromToml Node b) => a -> Text -> Parser b
(.:?) :: (Index a, FromToml Node b) => a -> Text -> Parser (Maybe b)
infixl 5 .:
infixl 5 .:?

-- | Assign default value to a parser that produces <a>Maybe</a>. Typically
--   used together with <a>.:?</a>:
--   
--   <pre>
--   foo .:? "bar" .!= 10
--   </pre>
(.!=) :: Functor m => m (Maybe a) -> a -> m a
infixl 5 .!=
pTable :: TomlParse m => L Node -> m (L Table)
pKey :: TomlParse m => Text -> L Table -> m (L Node)
pKeyMaybe :: Text -> L Table -> L (Maybe Node)
pStr :: TomlParse m => L Node -> m Text
pStrL :: TomlParse m => L Node -> m (L Text)
pBool :: TomlParse m => L Node -> m Bool
pInt :: TomlParse m => L Node -> m Int
pIntL :: TomlParse m => L Node -> m (L Int)
pDouble :: TomlParse m => L Node -> m Double
pDoubleL :: TomlParse m => L Node -> m (L Double)
pDatetime :: TomlParse m => L Node -> m UTCTime
pDatetimeL :: TomlParse m => L Node -> m (L UTCTime)
pTArray :: TomlParse m => L Node -> m (Vector (L Table))
pArray :: TomlParse m => L Node -> m (Vector (L Node))
pCases :: (Ord k, FromToml Node k, Pretty k) => Map k v -> L Node -> Parser v

-- | Prettyprint toml value.
ppToml :: Node -> Doc ann
instance GHC.Generics.Generic Data.Toml.Parse.TomlType
instance GHC.Show.Show Data.Toml.Parse.TomlType
instance GHC.Classes.Ord Data.Toml.Parse.TomlType
instance GHC.Classes.Eq Data.Toml.Parse.TomlType
instance GHC.Generics.Generic Data.Toml.Parse.TomlPath
instance GHC.Show.Show Data.Toml.Parse.TomlPath
instance GHC.Classes.Ord Data.Toml.Parse.TomlPath
instance GHC.Classes.Eq Data.Toml.Parse.TomlPath
instance GHC.Generics.Generic Data.Toml.Parse.AtomicTomlError
instance GHC.Show.Show Data.Toml.Parse.AtomicTomlError
instance GHC.Generics.Generic Data.Toml.Parse.TomlError
instance GHC.Show.Show Data.Toml.Parse.TomlError
instance GHC.Enum.Bounded Data.Toml.Parse.IsCommitted
instance GHC.Enum.Enum Data.Toml.Parse.IsCommitted
instance GHC.Show.Show Data.Toml.Parse.IsCommitted
instance GHC.Classes.Ord Data.Toml.Parse.IsCommitted
instance GHC.Classes.Eq Data.Toml.Parse.IsCommitted
instance GHC.Base.Functor Data.Toml.Parse.Validation
instance Prettyprinter.Internal.Pretty Data.Toml.Parse.ParseEnv
instance GHC.Generics.Generic Data.Toml.Parse.ParseEnv
instance GHC.Show.Show Data.Toml.Parse.ParseEnv
instance GHC.Classes.Ord Data.Toml.Parse.ParseEnv
instance GHC.Classes.Eq Data.Toml.Parse.ParseEnv
instance GHC.Base.MonadPlus Data.Toml.Parse.Parser
instance GHC.Base.Alternative Data.Toml.Parse.Parser
instance GHC.Base.Applicative Data.Toml.Parse.Parser
instance GHC.Base.Functor Data.Toml.Parse.Parser
instance GHC.Generics.Generic (Data.Toml.Parse.L a)
instance Data.Traversable.Traversable Data.Toml.Parse.L
instance Data.Foldable.Foldable Data.Toml.Parse.L
instance GHC.Base.Functor Data.Toml.Parse.L
instance GHC.Show.Show a => GHC.Show.Show (Data.Toml.Parse.L a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Data.Toml.Parse.L a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.Toml.Parse.L a)
instance Data.Toml.Parse.Index (Data.Toml.Parse.L Text.Toml.Types.Table)
instance Data.Toml.Parse.Index (Data.Toml.Parse.L Text.Toml.Types.Node)
instance (a GHC.Types.~ Data.Toml.Parse.L Text.Toml.Types.Node) => Data.Toml.Parse.Index (Data.Toml.Parse.Parser a)
instance Data.Toml.Parse.FromToml a (Data.Toml.Parse.L a)
instance Data.Toml.Parse.FromToml a a
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node GHC.Base.String
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node Data.Text.Internal.Text
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node GHC.Types.Bool
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node GHC.Types.Int
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node GHC.Types.Double
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node Data.Time.Clock.Internal.UTCTime.UTCTime
instance (GHC.Classes.Ord k, Data.Toml.Parse.FromToml Data.Text.Internal.Text k, Data.Toml.Parse.FromToml Text.Toml.Types.Node v) => Data.Toml.Parse.FromToml Text.Toml.Types.Node (Data.Map.Internal.Map k v)
instance (GHC.Classes.Ord k, Data.Toml.Parse.FromToml Data.Text.Internal.Text k, Data.Toml.Parse.FromToml Text.Toml.Types.Node v) => Data.Toml.Parse.FromToml Text.Toml.Types.Table (Data.Map.Internal.Map k v)
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node a => Data.Toml.Parse.FromToml Text.Toml.Types.Node (Data.Vector.Vector a)
instance Data.Toml.Parse.FromToml Text.Toml.Types.Node a => Data.Toml.Parse.FromToml Text.Toml.Types.Node (GHC.Base.NonEmpty a)
instance Data.Toml.Parse.TomlParse Data.Toml.Parse.Parser
instance Prettyprinter.Internal.Pretty a => Prettyprinter.Internal.Pretty (Data.Toml.Parse.L a)
instance Control.Comonad.Comonad Data.Toml.Parse.L
instance GHC.Base.Monad Data.Toml.Parse.Parser
instance GHC.Base.Applicative Data.Toml.Parse.Validation
instance GHC.Base.Alternative Data.Toml.Parse.Validation
instance GHC.Base.Monad Data.Toml.Parse.Validation
instance GHC.Base.MonadPlus Data.Toml.Parse.Validation
instance GHC.Base.Semigroup Data.Toml.Parse.IsCommitted
instance Prettyprinter.Internal.Pretty Data.Toml.Parse.TomlError
instance Prettyprinter.Internal.Pretty Data.Toml.Parse.AtomicTomlError
instance Prettyprinter.Internal.Pretty Data.Toml.Parse.TomlPath