opml-conduit-0.2.0.1: Streaming parser/renderer for the OPML 2.0 format.

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 Version OpmlHead (Forest OpmlOutline)

Instances

Eq Opml
Show Opml
Generic Opml
Default Opml
Arbitrary Opml
type Rep Opml

opmlVersion_ :: Lens' Opml Version

head_ :: Lens' Opml OpmlHead

outlines_ :: Lens' Opml (Forest OpmlOutline)

OPML header

Constructors

OpmlHead Text (Maybe UTCTime) (Maybe UTCTime) Text Text (Maybe URI) (Maybe URI) [Int] (Maybe Int) (HashMap Direction Int)

Instances

Eq OpmlHead
Show OpmlHead
Generic OpmlHead
Default OpmlHead	Use `def` as a smart constructor. All fields are set to `mempty`.
Arbitrary OpmlHead
type Rep OpmlHead

Constructors

Top'
Left'
Bottom'
Right'

Instances

Eq Direction
Show Direction
Generic Direction
Hashable Direction
Arbitrary Direction
type Rep Direction

opmlTitle_ :: Lens' OpmlHead Text

opmlCreated_ :: Lens' OpmlHead (Maybe UTCTime)

modified_ :: Lens' OpmlHead (Maybe UTCTime)

ownerName_ :: Lens' OpmlHead Text

ownerEmail_ :: Lens' OpmlHead Text

ownerId_ :: Lens' OpmlHead (Maybe URI)

docs_ :: Lens' OpmlHead (Maybe URI)

expansionState_ :: Lens' OpmlHead [Int]

vertScrollState_ :: Lens' OpmlHead (Maybe Int)

window_ :: Lens' OpmlHead (HashMap Direction Int)

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
Show OpmlOutline
Generic OpmlOutline
Arbitrary OpmlOutline
type Rep OpmlOutline

_OpmlOutlineGeneric :: Prism' OpmlOutline (OutlineBase, Text)

_OpmlOutlineLink :: Prism' OpmlOutline (OutlineBase, URI)

_OpmlOutlineSubscription :: Prism' OpmlOutline (OutlineBase, OutlineSubscription)

Generic outlines

data OutlineBase

Constructors

OutlineBase (NonNull Text) (Maybe Bool) (Maybe Bool) (Maybe UTCTime) [NonEmpty (NonNull Text)]

Instances

Eq OutlineBase
Show OutlineBase
Generic OutlineBase
Hashable OutlineBase
Arbitrary OutlineBase
type Rep OutlineBase

mkOutlineBase :: NonNull Text -> OutlineBase

Smart constructor for OutlineBase.

text_ :: Lens' OutlineBase (NonNull Text)

isComment_ :: Lens' OutlineBase (Maybe Bool)

isBreakpoint_ :: Lens' OutlineBase (Maybe Bool)

outlineCreated_ :: Lens' OutlineBase (Maybe UTCTime)

categories_ :: Lens' OutlineBase [NonEmpty (NonNull Text)]

Subscription outlines

data OutlineSubscription

Constructors

OutlineSubscription URI (Maybe URI) Text Text Text Text

Instances

Eq OutlineSubscription
Show OutlineSubscription
Generic OutlineSubscription
Arbitrary OutlineSubscription
type Rep OutlineSubscription

mkOutlineSubscription :: URI -> OutlineSubscription

Smart constructor for OutlineSubscription

xmlUri_ :: Lens' OutlineSubscription URI

htmlUri_ :: Lens' OutlineSubscription (Maybe URI)

description_ :: Lens' OutlineSubscription Text

language_ :: Lens' OutlineSubscription Text

subscriptionTitle_ :: Lens' OutlineSubscription Text

subscriptionVersion_ :: Lens' OutlineSubscription Text