Safe Haskell	None
Language	Haskell2010

Text.OPML.Types

Contents

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

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

data Opml = Opml {
- opmlVersion :: Version
- opmlHead :: OpmlHead
- opmlOutlines :: Forest OpmlOutline
}
mkOpml :: Opml
data OpmlHead = OpmlHead {
- 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
}
mkOpmlHead :: OpmlHead
data OpmlOutline
- = OpmlOutlineGeneric {
  - opmlOutlineBase :: OutlineBase
  - opmlOutlineContent :: Text
  }
- | OpmlOutlineLink {
  - opmlOutlineBase :: OutlineBase
  - opmlOutlineUri :: URI
  }
- | OpmlOutlineSubscription {
  - opmlOutlineBase :: OutlineBase
  - opmlOutlineSubscription :: OutlineSubscription
  }
data OutlineBase = OutlineBase {
- text :: Refined (Not Null) Text
- isComment :: Maybe Bool
- isBreakpoint :: Maybe Bool
- outlineCreated :: Maybe UTCTime
- categories :: [NonEmpty (Refined (Not Null) Text)]
}
mkOutlineBase :: Refined (Not Null) Text -> OutlineBase
data OutlineSubscription = OutlineSubscription {
- xmlUri :: URI
- htmlUri :: Maybe URI
- description :: Text
- language :: Text
- subscriptionTitle :: Text
- subscriptionVersion :: Text
}
mkOutlineSubscription :: URI -> OutlineSubscription
data Null

Top-level OPML structure

data Opml Source #

Constructors

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

Instances

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

mkOpml :: Opml Source #

Bare Opml. Version is set to 2.0.

OPML header

data OpmlHead Source #

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 Source #
Instance details Defined in Text.OPML.Types Methods (==) :: OpmlHead -> OpmlHead -> Bool # (/=) :: OpmlHead -> OpmlHead -> Bool #
Show OpmlHead Source #
Instance details Defined in Text.OPML.Types Methods showsPrec :: Int -> OpmlHead -> ShowS # show :: OpmlHead -> String # showList :: [OpmlHead] -> ShowS #
Generic OpmlHead Source #
Instance details Defined in Text.OPML.Types Associated Types type Rep OpmlHead :: Type -> Type # Methods from :: OpmlHead -> Rep OpmlHead x # to :: Rep OpmlHead x -> OpmlHead #
type Rep OpmlHead Source #
Instance details Defined in Text.OPML.Types type Rep OpmlHead = D1 (MetaData "OpmlHead" "Text.OPML.Types" "opml-conduit-0.9.0.0-LRpZeQLL3Vm2z3HXA9Ugdd" False) (C1 (MetaCons "OpmlHead" PrefixI True) (((S1 (MetaSel (Just "opmlTitle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "opmlCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)) :: S1 (MetaSel (Just "modified") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)))) :: (S1 (MetaSel (Just "ownerName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "ownerEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "ownerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI))))) :: ((S1 (MetaSel (Just "docs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :: (S1 (MetaSel (Just "expansionState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]) :: S1 (MetaSel (Just "vertScrollState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 (MetaSel (Just "windowBottom") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :: S1 (MetaSel (Just "windowLeft") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "windowRight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :: S1 (MetaSel (Just "windowTop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))))))

mkOpmlHead :: OpmlHead Source #

Bare OpmlHead, all fields are set to mempty.

OPML outlines

data OpmlOutline Source #

Outlines are the main payload of an OPML document.

Constructors

OpmlOutlineGeneric
Fields opmlOutlineBase :: OutlineBase opmlOutlineContent :: Text
OpmlOutlineLink
Fields opmlOutlineBase :: OutlineBase opmlOutlineUri :: URI
OpmlOutlineSubscription
Fields opmlOutlineBase :: OutlineBase opmlOutlineSubscription :: OutlineSubscription

Instances

Eq OpmlOutline Source #
Instance details Defined in Text.OPML.Types Methods (==) :: OpmlOutline -> OpmlOutline -> Bool # (/=) :: OpmlOutline -> OpmlOutline -> Bool #
Show OpmlOutline Source #
Instance details Defined in Text.OPML.Types Methods showsPrec :: Int -> OpmlOutline -> ShowS # show :: OpmlOutline -> String # showList :: [OpmlOutline] -> ShowS #
Generic OpmlOutline Source #
Instance details Defined in Text.OPML.Types Associated Types type Rep OpmlOutline :: Type -> Type # Methods from :: OpmlOutline -> Rep OpmlOutline x # to :: Rep OpmlOutline x -> OpmlOutline #
type Rep OpmlOutline Source #
Instance details Defined in Text.OPML.Types type Rep OpmlOutline = D1 (MetaData "OpmlOutline" "Text.OPML.Types" "opml-conduit-0.9.0.0-LRpZeQLL3Vm2z3HXA9Ugdd" False) (C1 (MetaCons "OpmlOutlineGeneric" PrefixI True) (S1 (MetaSel (Just "opmlOutlineBase") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutlineBase) :: S1 (MetaSel (Just "opmlOutlineContent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: (C1 (MetaCons "OpmlOutlineLink" PrefixI True) (S1 (MetaSel (Just "opmlOutlineBase") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutlineBase) :: S1 (MetaSel (Just "opmlOutlineUri") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URI)) :+: C1 (MetaCons "OpmlOutlineSubscription" PrefixI True) (S1 (MetaSel (Just "opmlOutlineBase") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutlineBase) :*: S1 (MetaSel (Just "opmlOutlineSubscription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutlineSubscription))))

Generic outlines

data OutlineBase Source #

Constructors

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

Instances

Eq OutlineBase Source #
Instance details Defined in Text.OPML.Types Methods (==) :: OutlineBase -> OutlineBase -> Bool # (/=) :: OutlineBase -> OutlineBase -> Bool #
Show OutlineBase Source #
Instance details Defined in Text.OPML.Types Methods showsPrec :: Int -> OutlineBase -> ShowS # show :: OutlineBase -> String # showList :: [OutlineBase] -> ShowS #
Generic OutlineBase Source #
Instance details Defined in Text.OPML.Types Associated Types type Rep OutlineBase :: Type -> Type # Methods from :: OutlineBase -> Rep OutlineBase x # to :: Rep OutlineBase x -> OutlineBase #
type Rep OutlineBase Source #
Instance details Defined in Text.OPML.Types type Rep OutlineBase = D1 (MetaData "OutlineBase" "Text.OPML.Types" "opml-conduit-0.9.0.0-LRpZeQLL3Vm2z3HXA9Ugdd" False) (C1 (MetaCons "OutlineBase" PrefixI True) ((S1 (MetaSel (Just "text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Refined (Not Null) Text)) :: S1 (MetaSel (Just "isComment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 (MetaSel (Just "isBreakpoint") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "outlineCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)) :: S1 (MetaSel (Just "categories") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [NonEmpty (Refined (Not Null) Text)])))))

mkOutlineBase :: Refined (Not Null) Text -> OutlineBase Source #

Smart constructor for OutlineBase.

Subscription outlines

data OutlineSubscription Source #

Constructors

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

Instances

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

mkOutlineSubscription :: URI -> OutlineSubscription Source #

Smart constructor for OutlineSubscription

Others

data Null Source #

Predicate on Text, true iff text is null.

Instances

Predicate Null Text Source #
Instance details Defined in Text.OPML.Types Methods validate :: Proxy Null -> Text -> Maybe RefineException #