Safe Haskell	None
Language	Haskell2010

Text.OPML.Types

Contents

Top-level OPML structure
OPML header
OPML outlines
- Generic outlines
- Subscription outlines

Description

OPML is an XML format for outlines.

Example:

<opml version="2.0">
  <head>
    <title>OPML title</title>
    <dateCreated>Mon, 31 Oct 2005 19:23:00 GMT</dateCreated>
  </head>
  <body>
    <outline text="Outline 1" created="Mon, 31 Oct 2005 18:21:33 GMT"/>
    <outline text="Outline 2" created="Mon, 31 Oct 2005 18:21:33 GMT"/>
  </body>
</opml>

Synopsis

Top-level OPML structure

data Opml #

Constructors

Opml
Fields opmlVersion :: Version opmlHead :: OpmlHead opmlOutlines :: Forest OpmlOutline

Instances

Eq Opml #
Methods (==) :: Opml -> Opml -> Bool # (/=) :: Opml -> Opml -> Bool #
Show Opml #
Methods showsPrec :: Int -> Opml -> ShowS # show :: Opml -> String # showList :: [Opml] -> ShowS #
Generic Opml #
Associated Types type Rep Opml :: * -> * # Methods from :: Opml -> Rep Opml x # to :: Rep Opml x -> Opml #
type Rep Opml #
type Rep Opml = D1 * (MetaData "Opml" "Text.OPML.Types" "opml-conduit-0.6.0.4-YV7psI0raPCDATsQ1Bscm" False) (C1 * (MetaCons "Opml" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "opmlVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Version)) ((::) (S1 * (MetaSel (Just Symbol "opmlHead") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * OpmlHead)) (S1 * (MetaSel (Just Symbol "opmlOutlines") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Forest OpmlOutline))))))

mkOpml :: Opml #

Bare Opml. Version is set to 2.0.

OPML header

data OpmlHead #

Constructors

OpmlHead
Fields opmlTitle :: Text opmlCreated :: Maybe UTCTime modified :: Maybe UTCTime ownerName :: Text ownerEmail :: Text ownerId :: Maybe URI docs :: Maybe URI expansionState :: [Int] vertScrollState :: Maybe Int windowBottom :: Maybe Int windowLeft :: Maybe Int windowRight :: Maybe Int windowTop :: Maybe Int

Instances

Eq OpmlHead #
Methods (==) :: OpmlHead -> OpmlHead -> Bool # (/=) :: OpmlHead -> OpmlHead -> Bool #
Show OpmlHead #
Methods showsPrec :: Int -> OpmlHead -> ShowS # show :: OpmlHead -> String # showList :: [OpmlHead] -> ShowS #
Generic OpmlHead #
Associated Types type Rep OpmlHead :: * -> * # Methods from :: OpmlHead -> Rep OpmlHead x # to :: Rep OpmlHead x -> OpmlHead #
type Rep OpmlHead #
type Rep OpmlHead = D1 * (MetaData "OpmlHead" "Text.OPML.Types" "opml-conduit-0.6.0.4-YV7psI0raPCDATsQ1Bscm" False) (C1 * (MetaCons "OpmlHead" PrefixI True) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "opmlTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "opmlCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe UTCTime))) (S1 * (MetaSel (Just Symbol "modified") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe UTCTime))))) ((::) (S1 * (MetaSel (Just Symbol "ownerName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "ownerEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "ownerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe URI)))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "docs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe URI))) ((::) (S1 * (MetaSel (Just Symbol "expansionState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int])) (S1 * (MetaSel (Just Symbol "vertScrollState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "windowBottom") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "windowLeft") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int)))) ((::) (S1 * (MetaSel (Just Symbol "windowRight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "windowTop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))))))))

mkOpmlHead :: OpmlHead #

Bare OpmlHead, all fields are set to mempty.

OPML outlines

data OpmlOutline #

Outlines are the main payload of an OPML document.

Constructors

OpmlOutlineGeneric OutlineBase Text
OpmlOutlineLink OutlineBase URI
OpmlOutlineSubscription OutlineBase OutlineSubscription

Instances

Eq OpmlOutline #
Methods (==) :: OpmlOutline -> OpmlOutline -> Bool # (/=) :: OpmlOutline -> OpmlOutline -> Bool #
Show OpmlOutline #
Methods showsPrec :: Int -> OpmlOutline -> ShowS # show :: OpmlOutline -> String # showList :: [OpmlOutline] -> ShowS #
Generic OpmlOutline #
Associated Types type Rep OpmlOutline :: * -> * # Methods from :: OpmlOutline -> Rep OpmlOutline x # to :: Rep OpmlOutline x -> OpmlOutline #
type Rep OpmlOutline #
type Rep OpmlOutline = D1 * (MetaData "OpmlOutline" "Text.OPML.Types" "opml-conduit-0.6.0.4-YV7psI0raPCDATsQ1Bscm" False) ((:+:) * (C1 * (MetaCons "OpmlOutlineGeneric" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * OutlineBase)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))) ((:+:) * (C1 * (MetaCons "OpmlOutlineLink" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * OutlineBase)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * URI)))) (C1 * (MetaCons "OpmlOutlineSubscription" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * OutlineBase)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * OutlineSubscription))))))

Generic outlines

data OutlineBase #

Constructors

OutlineBase
Fields text :: NonNull Text isComment :: Maybe Bool isBreakpoint :: Maybe Bool outlineCreated :: Maybe UTCTime categories :: [NonEmpty (NonNull Text)]

Instances

Eq OutlineBase #
Methods (==) :: OutlineBase -> OutlineBase -> Bool # (/=) :: OutlineBase -> OutlineBase -> Bool #
Show OutlineBase #
Methods showsPrec :: Int -> OutlineBase -> ShowS # show :: OutlineBase -> String # showList :: [OutlineBase] -> ShowS #
Generic OutlineBase #
Associated Types type Rep OutlineBase :: * -> * # Methods from :: OutlineBase -> Rep OutlineBase x # to :: Rep OutlineBase x -> OutlineBase #
type Rep OutlineBase #
type Rep OutlineBase = D1 * (MetaData "OutlineBase" "Text.OPML.Types" "opml-conduit-0.6.0.4-YV7psI0raPCDATsQ1Bscm" False) (C1 * (MetaCons "OutlineBase" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (NonNull Text))) (S1 * (MetaSel (Just Symbol "isComment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool)))) ((::) (S1 * (MetaSel (Just Symbol "isBreakpoint") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) ((::) (S1 * (MetaSel (Just Symbol "outlineCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe UTCTime))) (S1 * (MetaSel (Just Symbol "categories") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [NonEmpty (NonNull Text)]))))))

mkOutlineBase :: NonNull Text -> OutlineBase #

Smart constructor for OutlineBase.

Subscription outlines

data OutlineSubscription #

Constructors

OutlineSubscription
Fields xmlUri :: URI htmlUri :: Maybe URI description :: Text language :: Text subscriptionTitle :: Text subscriptionVersion :: Text

Instances

Eq OutlineSubscription #
Methods (==) :: OutlineSubscription -> OutlineSubscription -> Bool # (/=) :: OutlineSubscription -> OutlineSubscription -> Bool #
Show OutlineSubscription #
Methods showsPrec :: Int -> OutlineSubscription -> ShowS # show :: OutlineSubscription -> String # showList :: [OutlineSubscription] -> ShowS #
Generic OutlineSubscription #
Associated Types type Rep OutlineSubscription :: * -> * # Methods from :: OutlineSubscription -> Rep OutlineSubscription x # to :: Rep OutlineSubscription x -> OutlineSubscription #
type Rep OutlineSubscription #
type Rep OutlineSubscription = D1 * (MetaData "OutlineSubscription" "Text.OPML.Types" "opml-conduit-0.6.0.4-YV7psI0raPCDATsQ1Bscm" False) (C1 * (MetaCons "OutlineSubscription" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "xmlUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * URI)) ((::) (S1 * (MetaSel (Just Symbol "htmlUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe URI))) (S1 * (MetaSel (Just Symbol "description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))) ((::) (S1 * (MetaSel (Just Symbol "language") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "subscriptionTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "subscriptionVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text))))))

mkOutlineSubscription :: URI -> OutlineSubscription #

Smart constructor for OutlineSubscription