Text.XML.Light.Extractors.Internal

Documentation

type Path = [String]

Location for some content.

For now it is a reversed list of content indices (starting at 1) and element names. This may change to something less "stringly typed".

data Err

Extraction errors.

Constructors

ErrExpectContent

Some expected content is missing

Fields

• expectedContent :: String
• foundContent :: Content

ErrExpectAttrib

An expected attribute is missing

Fields

• expectedAttrib :: String

  name of expected attribute

• atElement :: Element

  element with missing attribute

ErrAttribValue

An attribute value was bad

Fields

• expectedValue :: String

  description of expected value

• foundValue :: String

  the value found

• atElement :: Element

  element with missing attribute

ErrEnd

Expected end of contents

Fields

• foundContent :: Content

ErrNull

Unexpected end of contents

Fields

• expectedContent :: String

ErrMsg String

Instances

Show Err

Methods

showsPrec :: Int -> Err -> ShowS

show :: Err -> String

showList :: [Err] -> ShowS

data ExtractionErr

Error with a context.

Constructors

ExtractionErr

Fields

• err :: Err
• context :: Path

Instances

Show ExtractionErr

Methods

showsPrec :: Int -> ExtractionErr -> ShowS

show :: ExtractionErr -> String

showList :: [ExtractionErr] -> ShowS

Error ExtractionErr

Methods

noMsg :: ExtractionErr

strMsg :: String -> ExtractionErr

Element extraction

type ElementExtractor a = ReaderT (Path, Element) (ResultT ExtractionErr Identity) a

runElementExtractor :: ElementExtractor a -> Element -> Path -> Result ExtractionErr a

attrib :: String -> ElementExtractor String

attribAs

Arguments

:: String

name of attribute to extract

-> (String -> Either String a)

function returning given string to some value or an error message

-> ElementExtractor a

children :: ContentsExtractor a -> ElementExtractor a

contents :: ContentsExtractor a -> ElementExtractor a

Contents extraction

type ContentsExtractor a = StateT Ctx (ResultT ExtractionErr Identity) a

runContentsExtractor :: ContentsExtractor a -> [Content] -> Int -> Path -> Result ExtractionErr (a, Ctx)

element :: String -> ElementExtractor a -> ContentsExtractor a

text :: ContentsExtractor String

textAs :: (String -> Either Err a) -> ContentsExtractor a

anyContent :: ContentsExtractor Content

eoc :: ContentsExtractor ()