| Safe Haskell | None |
|---|
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]
- fromEvents :: MonadThrow m => Consumer EventPos m Document
- renderBuilder :: Monad m => RenderSettings -> Document -> Producer m Builder
- renderBytes :: MonadUnsafeIO m => RenderSettings -> Document -> ConduitM a ByteString m ()
- renderText :: (MonadUnsafeIO m, MonadThrow m) => RenderSettings -> Document -> ConduitM a Text m ()
- data InvalidEventStream
- def :: Default a => a
- data ParseSettings
- psDecodeEntities :: ParseSettings -> DecodeEntities
- data RenderSettings
- rsPretty :: RenderSettings -> Bool
- rsNamespaces :: RenderSettings -> [(Text, Text)]
Non-streaming functions
Lazy bytestrings
renderLBS :: RenderSettings -> Document -> ByteStringSource
parseLBS_ :: ParseSettings -> ByteString -> DocumentSource
Text
parseText_ :: ParseSettings -> Text -> DocumentSource
sinkTextDoc :: MonadThrow m => ParseSettings -> Consumer Text m DocumentSource
Byte streams
sinkDoc :: MonadThrow m => ParseSettings -> Consumer ByteString m DocumentSource
Streaming functions
fromEvents :: MonadThrow m => Consumer EventPos m DocumentSource
renderBuilder :: Monad m => RenderSettings -> Document -> Producer m BuilderSource
renderBytes :: MonadUnsafeIO m => RenderSettings -> Document -> ConduitM a ByteString m ()Source
renderText :: (MonadUnsafeIO m, MonadThrow m) => RenderSettings -> Document -> ConduitM a Text m ()Source
Exceptions
data InvalidEventStream Source
Settings
Parse
data ParseSettings Source
Instances
Render
data RenderSettings Source
Instances
rsPretty :: RenderSettings -> BoolSource
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.