Text.XML.DOM.Parser.Types

Parser internals

data ParserError

DOM parser error description.

Constructors

PENotFound

Tag not found which should be.

Fields

• _pePath :: [Text]

  path of element

PEWrongFormat

Tag contents has wrong format, (could not read text to value)

Fields

• _peDetails :: Text
• _pePath :: [Text]

  path of element

PEContentNotFound

Node should have text content, but it does not.

Fields

• _pePath :: [Text]

  path of element

PEOther

Some other error

Fields

• _peDetails :: Text
• _pePath :: [Text]

  path of element

Instances

Eq ParserError

Methods

(==) :: ParserError -> ParserError -> Bool

(/=) :: ParserError -> ParserError -> Bool

Ord ParserError

Methods

compare :: ParserError -> ParserError -> Ordering

(<) :: ParserError -> ParserError -> Bool

(<=) :: ParserError -> ParserError -> Bool

(>) :: ParserError -> ParserError -> Bool

(>=) :: ParserError -> ParserError -> Bool

max :: ParserError -> ParserError -> ParserError

min :: ParserError -> ParserError -> ParserError

Show ParserError

Methods

showsPrec :: Int -> ParserError -> ShowS

show :: ParserError -> String

showList :: [ParserError] -> ShowS

Generic ParserError

Associated Types

type Rep ParserError :: * -> *

Methods

from :: ParserError -> Rep ParserError x

to :: Rep ParserError x -> ParserError

Exception ParserError

Methods

toException :: ParserError -> SomeException

fromException :: SomeException -> Maybe ParserError

displayException :: ParserError -> String

type Rep ParserError

type Rep ParserError = D1 (MetaData "ParserError" "Text.XML.DOM.Parser.Types" "dom-parser-0.1.1-C3vpdpVWY4x35pn3CEQC6i" False) ((:+:) ((:+:) (C1 (MetaCons "PENotFound" PrefixI True) (S1 (MetaSel (Just Symbol "_pePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))) (C1 (MetaCons "PEWrongFormat" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_peDetails") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))))) ((:+:) (C1 (MetaCons "PEContentNotFound" PrefixI True) (S1 (MetaSel (Just Symbol "_pePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))) (C1 (MetaCons "PEOther" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_peDetails") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))))))

pePath :: Lens' ParserError [Text]

peDetails :: Traversal' ParserError Text

newtype ParserErrors

Constructors

ParserErrors

Fields

• unParserErrors :: [ParserError]

Instances

Eq ParserErrors

Methods

(==) :: ParserErrors -> ParserErrors -> Bool

(/=) :: ParserErrors -> ParserErrors -> Bool

Ord ParserErrors

Methods

compare :: ParserErrors -> ParserErrors -> Ordering

(<) :: ParserErrors -> ParserErrors -> Bool

(<=) :: ParserErrors -> ParserErrors -> Bool

(>) :: ParserErrors -> ParserErrors -> Bool

(>=) :: ParserErrors -> ParserErrors -> Bool

max :: ParserErrors -> ParserErrors -> ParserErrors

min :: ParserErrors -> ParserErrors -> ParserErrors

Show ParserErrors

Methods

showsPrec :: Int -> ParserErrors -> ShowS

show :: ParserErrors -> String

showList :: [ParserErrors] -> ShowS

Generic ParserErrors

Associated Types

type Rep ParserErrors :: * -> *

Methods

from :: ParserErrors -> Rep ParserErrors x

to :: Rep ParserErrors x -> ParserErrors

Monoid ParserErrors

Methods

mempty :: ParserErrors

mappend :: ParserErrors -> ParserErrors -> ParserErrors

mconcat :: [ParserErrors] -> ParserErrors

Exception ParserErrors

Methods

toException :: ParserErrors -> SomeException

fromException :: SomeException -> Maybe ParserErrors

displayException :: ParserErrors -> String

type Rep ParserErrors

type Rep ParserErrors = D1 (MetaData "ParserErrors" "Text.XML.DOM.Parser.Types" "dom-parser-0.1.1-C3vpdpVWY4x35pn3CEQC6i" True) (C1 (MetaCons "ParserErrors" PrefixI True) (S1 (MetaSel (Just Symbol "unParserErrors") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ParserError])))

_ParserErrors :: Iso' ParserErrors [ParserError]

data ParserData f

Parser scope parser runs in. Functor argument is usually Identity or [].

If functor is Identity then parser expects exactly ONE current element. This is common behavior for content parsers, or parsers expecting strict XML structure.

If functor is [] then parser expects arbitrary current elements count. This is the case when you use combinators divePath or diveElem (posible other variants of similar combinators). This kind of combinators performs search for elements somewhere in descendants and result have arbitrary length in common case.

Constructors

ParserData

Fields

• _pdElements :: f Element

  Current element(s). Functor is intended to be either Identity or []

• _pdPath :: [Text]

  Path for error reporting

pdElements :: forall f f. Lens (ParserData f) (ParserData f) (f Element) (f Element)

pdPath :: forall f. Lens' (ParserData f) [Text]

Parser type

type DomParserT f m = ReaderT (ParserData f) (ExceptT ParserErrors m)

type DomParser f = DomParserT f Identity

runDomParserT :: Monad m => Document -> DomParserT Identity m a -> m (Either ParserErrors a)

Run parser on root element of Document.

runDomParser :: Document -> DomParser Identity a -> Either ParserErrors a

Auxiliary

class Traversable f => DomTraversable f where

Class of traversable functors which may be constructed from list. Or may not.

Minimal complete definition

buildDomTraversable

Methods

buildDomTraversable :: [a] -> Maybe (f a)

If method return Nothing this means we can not build traversable from given list. In this case combinator should fail traversing.

Instances

DomTraversable []

Methods

buildDomTraversable :: [a] -> Maybe [a]

DomTraversable Maybe

Methods

buildDomTraversable :: [a] -> Maybe (Maybe a)

DomTraversable Identity

Methods

buildDomTraversable :: [a] -> Maybe (Identity a)

DomTraversable NonEmpty

Methods

buildDomTraversable :: [a] -> Maybe (NonEmpty a)

throwParserError :: (MonadError ParserErrors m, MonadReader (ParserData f) m) => ([Text] -> ParserError) -> m a

throwWrongFormat :: (MonadError ParserErrors m, MonadReader (ParserData f) m) => Text -> m a

Throw PEWrongFormat as very common case