| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Text.XML.Unresolved
Contents
Description
DOM-based XML parsing and rendering.
In this module, attribute values and content nodes can contain either raw text or entities. In most cases, these can be fully resolved at parsing. If that is the case for your documents, the Text.XML module provides simplified datatypes that only contain raw text.
- writeFile :: RenderSettings -> FilePath -> Document -> IO ()
- readFile :: ParseSettings -> FilePath -> IO Document
- renderLBS :: RenderSettings -> Document -> ByteString
- parseLBS :: ParseSettings -> ByteString -> Either SomeException Document
- parseLBS_ :: ParseSettings -> ByteString -> Document
- parseText :: ParseSettings -> Text -> Either SomeException Document
- parseText_ :: ParseSettings -> Text -> Document
- sinkTextDoc :: MonadThrow m => ParseSettings -> Consumer Text m Document
- sinkDoc :: MonadThrow m => ParseSettings -> Consumer ByteString m Document
- toEvents :: Document -> [Event]
- elementToEvents :: Element -> [Event]
- fromEvents :: MonadThrow m => Consumer EventPos m Document
- elementFromEvents :: MonadThrow m => Consumer EventPos m (Maybe Element)
- renderBuilder :: Monad m => RenderSettings -> Document -> Producer m Builder
- renderBytes :: (MonadBase base m, PrimMonad base) => RenderSettings -> Document -> ConduitM a ByteString m ()
- renderText :: (MonadThrow m, MonadBase base m, PrimMonad base) => RenderSettings -> Document -> ConduitM a Text m ()
- data InvalidEventStream
- def :: Default a => a
- data ParseSettings
- psDecodeEntities :: ParseSettings -> DecodeEntities
- psRetainNamespaces :: ParseSettings -> Bool
- data RenderSettings
- rsPretty :: RenderSettings -> Bool
- rsNamespaces :: RenderSettings -> [(Text, Text)]
Non-streaming functions
Lazy bytestrings
renderLBS :: RenderSettings -> Document -> ByteString Source
parseLBS_ :: ParseSettings -> ByteString -> Document Source
Text
parseText :: ParseSettings -> Text -> Either SomeException Document Source
parseText_ :: ParseSettings -> Text -> Document Source
sinkTextDoc :: MonadThrow m => ParseSettings -> Consumer Text m Document Source
Byte streams
sinkDoc :: MonadThrow m => ParseSettings -> Consumer ByteString m Document Source
Streaming functions
elementToEvents :: Element -> [Event] Source
Render a document element into events.
Since: 1.3.5
fromEvents :: MonadThrow m => Consumer EventPos m Document Source
Parse a document from a stream of events.
elementFromEvents :: MonadThrow m => Consumer EventPos m (Maybe Element) Source
Try to parse a document element (as defined in XML) from a stream of events.
Since: 1.3.5
renderBuilder :: Monad m => RenderSettings -> Document -> Producer m Builder Source
renderBytes :: (MonadBase base m, PrimMonad base) => RenderSettings -> Document -> ConduitM a ByteString m () Source
renderText :: (MonadThrow m, MonadBase base m, PrimMonad base) => RenderSettings -> Document -> ConduitM a Text m () Source
Exceptions
data InvalidEventStream Source
Settings
Parse
data ParseSettings Source
Instances
psRetainNamespaces :: ParseSettings -> Bool Source
Whether the original xmlns attributes should be retained in the parsed values. For more information on motivation, see:
https://github.com/snoyberg/xml/issues/38
Default: False
Since 1.2.1
Render
data RenderSettings Source
Instances
rsPretty :: RenderSettings -> Bool Source
rsNamespaces :: RenderSettings -> [(Text, Text)] Source
Defines some top level namespace definitions to be used, in the form of (prefix, namespace). This has absolutely no impact on the meaning of your documents, but can increase readability by moving commonly used namespace declarations to the top level.