hxt-9.2.2: A collection of tools for processing XML with Haskell.

Portability | portable
Stability | stable
Maintainer | Uwe Schmidt (uwe@fh-wedel.de)
Safe Haskell | Safe-Infered

Text.XML.HXT.Arrow.XmlState.RunIOStateArrow

Description

run an io state arrow

Synopsis

- runX :: IOSArrow XmlTree c -> IO [c]
- runXIOState :: XIOState s -> IOStateArrow s XmlTree c -> IO [c]
- initialState :: us -> XIOState us
- initialSysState :: XIOSysState
- initialSysWriter :: XIOSysWriter
- initialSysEnv :: XIOSysEnv
- initialInputConfig :: XIOInputConfig
- initialParseConfig :: XIOParseConfig
- initialOutputConfig :: XIOOutputConfig
- initialRelaxConfig :: XIORelaxConfig
- initialCacheConfig :: XIOCacheConfig
- dummyHTTPHandler :: IOSArrow XmlTree XmlTree
- dummyTagSoupParser :: IOSArrow b b
- dummyExpatParser :: IOSArrow b b
- dummyRelaxValidator :: IOSArrow b b
- dummyCacheRead :: String -> IOSArrow b b
- getConfigAttr :: String -> SysConfigList -> String
- theSysConfigComp :: Selector XIOSysState a -> Selector SysConfig a

# Documentation

runX :: IOSArrow XmlTree c -> IO [c]

apply an `IOSArrow` to an empty root node with `initialState` () as initial state

the main entry point for running a state arrow with IO

when running `runX f` an empty XML root node is applied to `f`. usually `f` will start with a constant arrow (ignoring the input), e.g. a `readDocument` arrow.

for usage see examples with `writeDocument`

if input has to be feed into the arrow use `runIOSLA` like in `runIOSLA f emptyX inputDoc`

runXIOState :: XIOState s -> IOStateArrow s XmlTree c -> IO [c]

initialState :: us -> XIOState us

the default global state, used as initial state when running an `IOSArrow` with `runIOSLA` or `runX`

initialSysState :: XIOSysState

initialSysWriter :: XIOSysWriter

initialSysEnv :: XIOSysEnv

initialInputConfig :: XIOInputConfig

initialParseConfig :: XIOParseConfig

initialOutputConfig :: XIOOutputConfig

initialRelaxConfig :: XIORelaxConfig

initialCacheConfig :: XIOCacheConfig

dummyHTTPHandler :: IOSArrow XmlTree XmlTree

dummyTagSoupParser :: IOSArrow b b

dummyExpatParser :: IOSArrow b b

dummyRelaxValidator :: IOSArrow b b

dummyCacheRead :: String -> IOSArrow b b

getConfigAttr :: String -> SysConfigList -> String

theSysConfigComp :: Selector XIOSysState a -> Selector SysConfig a