xml-conduit-1.9.1.4: Pure-Haskell utilities for dealing with XML with the conduit package.
Safe HaskellNone
LanguageHaskell2010

Text.XML.Unresolved

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.

Synopsis

Non-streaming functions

writeFile :: RenderSettings -> FilePath -> Document -> IO () Source #

readFile :: ParseSettings -> FilePath -> IO Document Source #

Lazy bytestrings

renderLBS :: RenderSettings -> Document -> ByteString Source #

parseLBS :: ParseSettings -> ByteString -> Either SomeException Document Source #

parseLBS_ :: ParseSettings -> ByteString -> Document Source #

Text

parseText :: ParseSettings -> Text -> Either SomeException Document Source #

parseText_ :: ParseSettings -> Text -> Document Source #

sinkTextDoc :: forall (m :: Type -> Type) o. MonadThrow m => ParseSettings -> ConduitT Text o m Document Source #

Byte streams

sinkDoc :: forall (m :: Type -> Type) o. MonadThrow m => ParseSettings -> ConduitT ByteString o m Document Source #

Streaming functions

toEvents :: Document -> [Event] Source #

Render a document into events.

elementToEvents :: Element -> [Event] Source #

Render a document element into events.

Since: 1.3.5

fromEvents :: forall (m :: Type -> Type) o. MonadThrow m => ConduitT EventPos o m Document Source #

Parse a document from a stream of events.

elementFromEvents :: forall (m :: Type -> Type) o. MonadThrow m => ConduitT EventPos o m (Maybe Element) Source #

Try to parse a document element (as defined in XML) from a stream of events.

Since: 1.3.5

renderBuilder :: forall (m :: Type -> Type) i. Monad m => RenderSettings -> Document -> ConduitT i Builder m () Source #

renderBytes :: forall (m :: Type -> Type) i. PrimMonad m => RenderSettings -> Document -> ConduitT i ByteString m () Source #

renderText :: forall (m :: Type -> Type) i. (MonadThrow m, PrimMonad m) => RenderSettings -> Document -> ConduitT i Text m () Source #

Exceptions

Settings

def :: Default a => a #

Parse

data ParseSettings Source #

Instances

Instances details
Default ParseSettings Source # 
Instance details

Defined in Text.XML.Stream.Parse

Methods

def :: ParseSettings #

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

Instances details
Default RenderSettings Source # 
Instance details

Defined in Text.XML.Stream.Render

Methods

def :: RenderSettings #

rsPretty :: RenderSettings -> Bool Source #

Deprecated: Will be removed in future versions of `xml-conduit`. See https://github.com/snoyberg/xml/issues/196.

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.