Text.XML.Hexml.Lens

Nodes

_children :: Getter Node [Node]

Getter for the element children

class XML s where

Minimal complete definition

textContents, iattributes, nodes

Methods

_XML :: Prism' s Node

A prism for parsing and unparsing XML.

unparsing is provided by outer.

>>> "<?xml version=\"1.0\"?><foo/>" ^? _XML
Just Node "<?xml version=\"1.0\"?><foo/>"

Nameless nodes are inserted for trees with >1 root.

>>> "<?xml version=\"1.0\"?><foo/>" ^? _XML.to name
Just ""

>>> "<?xml version=\"1.0\"?><foo/>" ^? _XML._children.ix(0)
Just Node "<?xml version=\"1.0\"?>"

>>> "<?xml version=\"1.0\"?><foo/>" ^? _XML._children.ix(1)
Just Node "<foo/>"

If the tree has only 1 root, no nameless nodes are inserted.

>>> "<foo/>" ^? _XML.re(_XML @String)._XML.to name
Just "foo"

The law x ^? re _XML . _XML == x doesn't hold for the nameless nodes injected by parse.

>>> parse "<foo/>" ^? _Right.to name
Just ""
>>> parse "<foo/>" ^? _Right.re(_XML @String)._XML.to name
Just "foo"

_contents :: Fold Node (Either s Node)

Fold over all the children (text and element)

_inner :: Getter Node s

Getter for the inner contents of a node

_outer :: Getter Node s

Getter for the inner contents of a node

textContents :: Fold Node s

Fold for accessing the text contents of a node

_Attribute :: s -> Getter Node (Maybe s)

Fold for accessing attributes by name.

iattributes :: IndexedFold String Node s

Name-Indexed fold over the attribute values

nodes :: s -> Getter Node [Node]

A getter for accessing named children nodes This is a more efficient version of

nodes foo = _children . to (filter (\n -> name n == foo))

Instances

XML String

Methods

_XML :: Prism' String Node

_contents :: Fold Node (Either String Node)

_inner :: Getter Node String

_outer :: Getter Node String

textContents :: Fold Node String

_Attribute :: String -> Getter Node (Maybe String)

iattributes :: IndexedFold String Node String

nodes :: String -> Getter Node [Node]

XML ByteString

Methods

_XML :: Prism' ByteString Node

_contents :: Fold Node (Either ByteString Node)

_inner :: Getter Node ByteString

_outer :: Getter Node ByteString

textContents :: Fold Node ByteString

_Attribute :: ByteString -> Getter Node (Maybe ByteString)

iattributes :: IndexedFold String Node ByteString

nodes :: ByteString -> Getter Node [Node]

XML ByteString

Methods

_XML :: Prism' ByteString Node

_contents :: Fold Node (Either ByteString Node)

_inner :: Getter Node ByteString

_outer :: Getter Node ByteString

textContents :: Fold Node ByteString

_Attribute :: ByteString -> Getter Node (Maybe ByteString)

iattributes :: IndexedFold String Node ByteString

nodes :: ByteString -> Getter Node [Node]

XML String

Methods

_XML :: Prism' String Node

_contents :: Fold Node (Either String Node)

_inner :: Getter Node String

_outer :: Getter Node String

textContents :: Fold Node String

_Attribute :: String -> Getter Node (Maybe String)

iattributes :: IndexedFold String Node String

nodes :: String -> Getter Node [Node]

XML Text

Methods

_XML :: Prism' Text Node

_contents :: Fold Node (Either Text Node)

_inner :: Getter Node Text

_outer :: Getter Node Text

textContents :: Fold Node Text

_Attribute :: Text -> Getter Node (Maybe Text)

iattributes :: IndexedFold String Node Text

nodes :: Text -> Getter Node [Node]

XML Text

Methods

_XML :: Prism' Text Node

_contents :: Fold Node (Either Text Node)

_inner :: Getter Node Text

_outer :: Getter Node Text

textContents :: Fold Node Text

_Attribute :: Text -> Getter Node (Maybe Text)

iattributes :: IndexedFold String Node Text

nodes :: Text -> Getter Node [Node]

node :: XML s => s -> Fold Node Node

node n = nodes n . folded

multiple :: Getting [a] s a -> IndexPreservingGetter s [a]