Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Data.XML

Description

Synopsis

(.@) :: FromXML a => [Node] -> Text -> Either String a
(.@?) :: FromXML a => [Node] -> Text -> Either String (Maybe a)
(@=) :: ToXML a => Name -> a -> XML
(@@=) :: ToText a => Name -> a -> XML
decodeXML :: FromXML a => ByteStringLazy -> Either String a
encodeXML :: ToElement a => a -> ByteStringLazy
class FromXML a where
- parseXML :: [Node] -> Either String a
class ToElement a where
- toElement :: a -> Element
maybeElement :: ToElement a => a -> Maybe Element
data XML
- = XNull
- | XAttr Name Text
- | XOne Node
- | XMany [(Name, Text)] [Node]
listXMLNodes :: XML -> [Node]
listXMLAttributes :: XML -> [(Name, Text)]
class ToXML a where
- toXML :: a -> XML
parseXMLMap :: (Eq k, Hashable k, FromText k, FromXML v) => Text -> Text -> Text -> [Node] -> Either String (HashMap k v)
parseXMLList1 :: FromXML a => Text -> [Node] -> Either String (NonEmpty a)
parseXMLList :: FromXML a => Text -> [Node] -> Either String [a]
parseXMLText :: FromText a => String -> [Node] -> Either String a
toXMLList :: (IsList a, ToXML (Item a)) => Name -> a -> XML
toXMLText :: ToText a => a -> XML
mkElement :: ToXML a => Name -> a -> Element
withContent :: String -> [Node] -> Either String (Maybe Text)
findElement :: Text -> [Node] -> Either String [Node]
firstElement :: Text -> [Node] -> Either String [Node]
childNodesOf :: Text -> Node -> Maybe [Node]
childrenOf :: Element -> [Node]
localName :: Node -> Maybe Text
rootElementName :: ByteStringLazy -> Maybe Text
missingElement :: Text -> [Node] -> Maybe a -> Either String a

Documentation

(.@) :: FromXML a => [Node] -> Text -> Either String a infixl 7 Source #

(.@?) :: FromXML a => [Node] -> Text -> Either String (Maybe a) infixl 7 Source #

(@=) :: ToXML a => Name -> a -> XML infixr 7 Source #

(@@=) :: ToText a => Name -> a -> XML infixr 7 Source #

decodeXML :: FromXML a => ByteStringLazy -> Either String a Source #

encodeXML :: ToElement a => a -> ByteStringLazy Source #

class FromXML a where Source #

Methods

parseXML :: [Node] -> Either String a Source #

Instances

Instances details

FromXML Base64 Source #
Instance details Defined in Amazonka.Data.Base64 Methods parseXML :: [Node] -> Either String Base64 Source #
FromXML AWSTime Source #
Instance details Defined in Amazonka.Data.Time Methods parseXML :: [Node] -> Either String AWSTime Source #
FromXML BasicTime Source #
Instance details Defined in Amazonka.Data.Time Methods parseXML :: [Node] -> Either String BasicTime Source #
FromXML ISO8601 Source #
Instance details Defined in Amazonka.Data.Time Methods parseXML :: [Node] -> Either String ISO8601 Source #
FromXML RFC822 Source #
Instance details Defined in Amazonka.Data.Time Methods parseXML :: [Node] -> Either String RFC822 Source #
FromXML Abbrev Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Abbrev Source #
FromXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AccessKey Source #
FromXML AuthEnv Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String AuthEnv Source #
FromXML ErrorCode Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorCode Source #
FromXML ErrorMessage Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String ErrorMessage Source #
FromXML Region Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String Region Source #
FromXML RequestId Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String RequestId Source #
FromXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SecretKey Source #
FromXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods parseXML :: [Node] -> Either String SessionToken Source #
FromXML ByteString Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String ByteString Source #
FromXML Text Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Text Source #
FromXML Integer Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Integer Source #
FromXML Natural Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Natural Source #
FromXML Bool Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Bool Source #
FromXML Char Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Char Source #
FromXML Double Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Double Source #
FromXML Int Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String Int Source #
FromXML a => FromXML (Sensitive a) Source #
Instance details Defined in Amazonka.Data.Sensitive Methods parseXML :: [Node] -> Either String (Sensitive a) Source #
FromXML a => FromXML (Maybe a) Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String (Maybe a) Source #
FromXML [Node] Source #
Instance details Defined in Amazonka.Data.XML Methods parseXML :: [Node] -> Either String [Node] Source #

class ToElement a where Source #

Methods

toElement :: a -> Element Source #

Instances

Instances details

ToElement Element Source #
Instance details Defined in Amazonka.Data.XML Methods toElement :: Element -> Element Source #

maybeElement :: ToElement a => a -> Maybe Element Source #

Convert to an Element, only if the resulting element contains > 0 nodes.

data XML Source #

Provides a way to make the operators for ToXML instance declaration be consistent WRT to single nodes or lists of nodes.

Constructors

XNull
XAttr Name Text
XOne Node
XMany [(Name, Text)] [Node]

Instances

Instances details

ToXML XML Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: XML -> XML Source #
Monoid XML Source #
Instance details Defined in Amazonka.Data.XML Methods mempty :: XML # mappend :: XML -> XML -> XML # mconcat :: [XML] -> XML #
Semigroup XML Source #
Instance details Defined in Amazonka.Data.XML Methods (<>) :: XML -> XML -> XML # sconcat :: NonEmpty XML -> XML # stimes :: Integral b => b -> XML -> XML #
Show XML Source #
Instance details Defined in Amazonka.Data.XML Methods showsPrec :: Int -> XML -> ShowS # show :: XML -> String # showList :: [XML] -> ShowS #

listXMLNodes :: XML -> [Node] Source #

listXMLAttributes :: XML -> [(Name, Text)] Source #

class ToXML a where Source #

Methods

toXML :: a -> XML Source #

Instances

Instances details

ToXML Base64 Source #
Instance details Defined in Amazonka.Data.Base64 Methods toXML :: Base64 -> XML Source #
ToXML AWSTime Source #
Instance details Defined in Amazonka.Data.Time Methods toXML :: AWSTime -> XML Source #
ToXML BasicTime Source #
Instance details Defined in Amazonka.Data.Time Methods toXML :: BasicTime -> XML Source #
ToXML ISO8601 Source #
Instance details Defined in Amazonka.Data.Time Methods toXML :: ISO8601 -> XML Source #
ToXML RFC822 Source #
Instance details Defined in Amazonka.Data.Time Methods toXML :: RFC822 -> XML Source #
ToXML XML Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: XML -> XML Source #
ToXML AccessKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: AccessKey -> XML Source #
ToXML Region Source #
Instance details Defined in Amazonka.Types Methods toXML :: Region -> XML Source #
ToXML SecretKey Source #
Instance details Defined in Amazonka.Types Methods toXML :: SecretKey -> XML Source #
ToXML SessionToken Source #
Instance details Defined in Amazonka.Types Methods toXML :: SessionToken -> XML Source #
ToXML ByteString Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: ByteString -> XML Source #
ToXML Text Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Text -> XML Source #
ToXML Integer Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Integer -> XML Source #
ToXML Natural Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Natural -> XML Source #
ToXML Bool Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Bool -> XML Source #
ToXML Double Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Double -> XML Source #
ToXML Int Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Int -> XML Source #
ToXML a => ToXML (Sensitive a) Source #
Instance details Defined in Amazonka.Data.Sensitive Methods toXML :: Sensitive a -> XML Source #
ToXML a => ToXML (Maybe a) Source #
Instance details Defined in Amazonka.Data.XML Methods toXML :: Maybe a -> XML Source #