hextream-0.3.0.0: Streaming-friendly XML parsers
Safe HaskellNone
LanguageHaskell2010

Data.XML.Parser.Low.Reference

Description

Low-level parsers for XML references.

All documentation examples assume the following setup:

:set -XOverloadedStrings
import Data.Attoparsec.ByteString
Synopsis

Documentation

>>> :set -XOverloadedStrings
>>> import Data.Attoparsec.ByteString

data Reference Source #

https://www.w3.org/TR/REC-xml/#dt-entref

Entity reference, or character reference.

Constructors

EntityRef Text 
CharRef Char 

Instances

Instances details
Eq Reference Source # 
Instance details

Defined in Data.XML.Parser.Low.Reference

Methods

(==) :: Reference -> Reference -> Bool #

(/=) :: Reference -> Reference -> Bool #

Ord Reference Source # 
Instance details

Defined in Data.XML.Parser.Low.Reference

Methods

compare :: Reference -> Reference -> Ordering #

(<) :: Reference -> Reference -> Bool #

(<=) :: Reference -> Reference -> Bool #

(>) :: Reference -> Reference -> Bool #

(>=) :: Reference -> Reference -> Bool #

max :: Reference -> Reference -> Reference #

min :: Reference -> Reference -> Reference #

Read Reference Source # 
Instance details

Defined in Data.XML.Parser.Low.Reference

Methods

readsPrec :: Int -> ReadS Reference #

readList :: ReadS [Reference] #

readPrec :: ReadPrec Reference #

readListPrec :: ReadPrec [Reference] #

Show Reference Source # 
Instance details

Defined in Data.XML.Parser.Low.Reference

Methods

showsPrec :: Int -> Reference -> ShowS #

show :: Reference -> String #

showList :: [Reference] -> ShowS #

expandReference :: Alternative m => EntityDecoder -> Reference -> m Text Source #

Resolve reference into raw text.

expandReference' :: Reference -> Maybe Text Source #

Same as expandReference decodePredefinedEntities, provided for convenience.

tokenReference :: CharParsing m => Monad m => m Reference Source #

https://www.w3.org/TR/REC-xml/#NT-Reference

>>> parseOnly tokenReference "&#x3C;"
Right (CharRef '<')
>>> parseOnly tokenReference "&docdate;"
Right (EntityRef "docdate")