XmlParser

Execution

parseByteString :: Element a -> ByteString -> Either Text a

Parse XML bytestring.

parseLazyByteString :: Element a -> ByteString -> Either Text a

Parse XML lazy bytestring.

parseFile :: Element a -> FilePath -> IO (Either Text a)

Parse XML file.

parseElementAst :: Element a -> Element -> Either Text a

Parse an "xml-conduit" element AST.

Parsers by context

Element

data Element a

Parse in the context of an element node.

Instances

MonadFail Element

Defined in XmlParser.AstParser

Methods

fail :: String -> Element a

Applicative Element

Defined in XmlParser.AstParser

Methods

pure :: a -> Element a

(<*>) :: Element (a -> b) -> Element a -> Element b

liftA2 :: (a -> b -> c) -> Element a -> Element b -> Element c

(*>) :: Element a -> Element b -> Element b

(<*) :: Element a -> Element b -> Element a

Functor Element

Defined in XmlParser.AstParser

Methods

fmap :: (a -> b) -> Element a -> Element b

(<$) :: a -> Element b -> Element a

Monad Element

Defined in XmlParser.AstParser

Methods

(>>=) :: Element a -> (a -> Element b) -> Element b

(>>) :: Element a -> Element b -> Element b

return :: a -> Element a

elementName :: (Maybe Text -> Text -> Either Text a) -> Element a

Parse namespace and name with the given function.

elementNameIs :: Maybe Text -> Text -> Element ()

Fail if the namespace and name don't match the provided.

children :: Nodes a -> Element a

Children sequence by order.

childrenByName :: ByName Element a -> Element a

Look up elements by name and parse them.

attributesByName :: ByName Content a -> Element a

Look up the last attribute by name and parse it.

astElement :: Element Element

Expose the element's AST.

Nodes

data Nodes a

Parser in the context of a sequence of nodes.

Instances

Applicative Nodes

Defined in XmlParser.AstParser

Methods

pure :: a -> Nodes a

(<*>) :: Nodes (a -> b) -> Nodes a -> Nodes b

liftA2 :: (a -> b -> c) -> Nodes a -> Nodes b -> Nodes c

(*>) :: Nodes a -> Nodes b -> Nodes b

(<*) :: Nodes a -> Nodes b -> Nodes a

Functor Nodes

Defined in XmlParser.AstParser

Methods

fmap :: (a -> b) -> Nodes a -> Nodes b

(<$) :: a -> Nodes b -> Nodes a

Monad Nodes

Defined in XmlParser.AstParser

Methods

(>>=) :: Nodes a -> (a -> Nodes b) -> Nodes b

(>>) :: Nodes a -> Nodes b -> Nodes b

return :: a -> Nodes a

elementNode :: Element a -> Nodes a

Consume the next node expecting it to be element and parse its contents.

contentNode :: Content content -> Nodes content

Consume the next node expecting it to be textual and parse its contents.

ByName

data ByName parser a

Composable extension to a parser, which looks up its input by name.

Useful for searching elements and attributes by name.

Alternative and MonadPlus alternate only on lookup errors. When lookup is successful, but the deeper parser fails, the error propagates.

Monad and Applicative sequentially fetch contents by matching names.

Instances

Alternative (ByName parser)

Defined in XmlParser.AstParser

Methods

empty :: ByName parser a

(<|>) :: ByName parser a -> ByName parser a -> ByName parser a

some :: ByName parser a -> ByName parser [a]

many :: ByName parser a -> ByName parser [a]

Applicative (ByName parser)

Defined in XmlParser.AstParser

Methods

pure :: a -> ByName parser a

(<*>) :: ByName parser (a -> b) -> ByName parser a -> ByName parser b

liftA2 :: (a -> b -> c) -> ByName parser a -> ByName parser b -> ByName parser c

(*>) :: ByName parser a -> ByName parser b -> ByName parser b

(<*) :: ByName parser a -> ByName parser b -> ByName parser a

Functor (ByName parser)

Defined in XmlParser.AstParser

Methods

fmap :: (a -> b) -> ByName parser a -> ByName parser b

(<$) :: a -> ByName parser b -> ByName parser a

Monad (ByName parser)

Defined in XmlParser.AstParser

Methods

(>>=) :: ByName parser a -> (a -> ByName parser b) -> ByName parser b

(>>) :: ByName parser a -> ByName parser b -> ByName parser b

return :: a -> ByName parser a

MonadPlus (ByName parser)

Defined in XmlParser.AstParser

Methods

mzero :: ByName parser a

mplus :: ByName parser a -> ByName parser a -> ByName parser a

byName :: Maybe Text -> Text -> parser a -> ByName parser a

Execute a parser on the result of looking up a content by namespace and name.

Content

data Content content

Parser in the context of decoded textual content, which can be the value of an attribute or a textual node.

Instances

MonadFail Content

Defined in XmlParser.AstParser

Methods

fail :: String -> Content a

Alternative Content

Defined in XmlParser.AstParser

Methods

empty :: Content a

(<|>) :: Content a -> Content a -> Content a

some :: Content a -> Content [a]

many :: Content a -> Content [a]

Applicative Content

Defined in XmlParser.AstParser

Methods

pure :: a -> Content a

(<*>) :: Content (a -> b) -> Content a -> Content b

liftA2 :: (a -> b -> c) -> Content a -> Content b -> Content c

(*>) :: Content a -> Content b -> Content b

(<*) :: Content a -> Content b -> Content a

Functor Content

Defined in XmlParser.AstParser

Methods

fmap :: (a -> b) -> Content a -> Content b

(<$) :: a -> Content b -> Content a

Monad Content

Defined in XmlParser.AstParser

Methods

(>>=) :: Content a -> (a -> Content b) -> Content b

(>>) :: Content a -> Content b -> Content b

return :: a -> Content a

MonadPlus Content

Defined in XmlParser.AstParser

Methods

mzero :: Content a

mplus :: Content a -> Content a -> Content a

textContent :: Content Text

Return the content as it is.

narrowedContent :: (Text -> Maybe a) -> Content a

Map the content to a type if it's valid.

refinedContent :: (Text -> Either Text a) -> Content a

Parse the content with a possibly failing function.

enumContent :: [(Text, a)] -> Content a

Map the content using a dictionary.

attoparsedContent :: Parser a -> Content a

Parse the content using the "attoparsec" parser.

qNameContent :: Content (Maybe Text, Text)

Parse the content as XML Schema QName, automatically resolving the namespace as URI and failing, if none is associated.

Produces a URI associated with the namespace and name. If the content does not contain colon, produces an unnamespaced name.

Refs:

• https://www.w3.org/2001/tag/doc/qnameids.html#sec-qnames-xml
• https://en.wikipedia.org/wiki/QName