pinboard-0.9.12.10: Access to the Pinboard API

Copyright	(c) Jon Schoning 2015
Maintainer	jonschoning@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Pinboard.Types

Description

Synopsis

type PinboardEnv = (PinboardConfig, Manager)
type PinboardT m a = ReaderT PinboardEnv (ExceptT PinboardError (LoggingT m)) a
runPinboardT :: (MonadIO m, MonadCatch m) => PinboardEnv -> PinboardT m a -> m (Either PinboardError a)
type MonadPinboard m = (Functor m, Applicative m, MonadIO m, MonadCatch m, MonadReader PinboardEnv m, MonadLogger m)
type ExecLoggingT = forall m. MonadIO m => forall a. LoggingT m a -> m a
data PinboardConfig = PinboardConfig {
- apiToken :: !ByteString
- maxRequestRateMills :: !Int
- lastRequestTime :: IORef UTCTime
- doThreadDelay :: PinboardConfig -> IO ()
- execLoggingT :: ExecLoggingT
- filterLoggingT :: LogSource -> LogLevel -> Bool
}
runConfigLoggingT :: PinboardConfig -> ExecLoggingT
data PinboardRequest = PinboardRequest {
- requestPath :: !Text
- requestParams :: [Param]
}
data ResultFormatType
- = FormatJson
- | FormatXml
data Param
- = Format !ResultFormatType
- | Tag !Text
- | Tags !Text
- | Old !Text
- | New !Text
- | Count !Int
- | Start !Int
- | Results !Int
- | Url !Text
- | Date !Day
- | DateTime !UTCTime
- | FromDateTime !UTCTime
- | ToDateTime !UTCTime
- | Replace !Bool
- | Shared !Bool
- | ToRead !Bool
- | Description !Text
- | Extended !Text
- | Meta !Int
type ParamsBS = [(ByteString, ByteString)]

Documentation

type PinboardEnv = (PinboardConfig, Manager) #

type PinboardT m a = ReaderT PinboardEnv (ExceptT PinboardError (LoggingT m)) a #

runPinboardT :: (MonadIO m, MonadCatch m) => PinboardEnv -> PinboardT m a -> m (Either PinboardError a) #

type MonadPinboard m = (Functor m, Applicative m, MonadIO m, MonadCatch m, MonadReader PinboardEnv m, MonadLogger m) #

Typeclass alias for the return type of the API functions (keeps the signatures less verbose)

type ExecLoggingT = forall m. MonadIO m => forall a. LoggingT m a -> m a #

data PinboardConfig #

Constructors

PinboardConfig
Fields apiToken :: !ByteString maxRequestRateMills :: !Int lastRequestTime :: IORef UTCTime doThreadDelay :: PinboardConfig -> IO () execLoggingT :: ExecLoggingT filterLoggingT :: LogSource -> LogLevel -> Bool

Instances

Show PinboardConfig #
Instance details Defined in Pinboard.Types Methods showsPrec :: Int -> PinboardConfig -> ShowS # show :: PinboardConfig -> String # showList :: [PinboardConfig] -> ShowS #

runConfigLoggingT :: PinboardConfig -> ExecLoggingT #

data PinboardRequest #

Constructors

PinboardRequest
Fields requestPath :: !Text url path of PinboardRequest requestParams :: [Param] Query Parameters of PinboardRequest

Instances

Show PinboardRequest #
Instance details Defined in Pinboard.Types Methods showsPrec :: Int -> PinboardRequest -> ShowS # show :: PinboardRequest -> String # showList :: [PinboardRequest] -> ShowS #

data ResultFormatType #

Constructors

FormatJson
FormatXml

Instances

Eq ResultFormatType #
Instance details Defined in Pinboard.Types Methods (==) :: ResultFormatType -> ResultFormatType -> Bool # (/=) :: ResultFormatType -> ResultFormatType -> Bool #
Show ResultFormatType #
Instance details Defined in Pinboard.Types Methods showsPrec :: Int -> ResultFormatType -> ShowS # show :: ResultFormatType -> String # showList :: [ResultFormatType] -> ShowS #

data Param #

Constructors

Format !ResultFormatType
Tag !Text
Tags !Text
Old !Text
New !Text
Count !Int
Start !Int
Results !Int
Url !Text
Date !Day
DateTime !UTCTime
FromDateTime !UTCTime
ToDateTime !UTCTime
Replace !Bool
Shared !Bool
ToRead !Bool
Description !Text
Extended !Text
Meta !Int

Instances

Eq Param #
Instance details Defined in Pinboard.Types Methods (==) :: Param -> Param -> Bool # (/=) :: Param -> Param -> Bool #
Show Param #
Instance details Defined in Pinboard.Types Methods showsPrec :: Int -> Param -> ShowS # show :: Param -> String # showList :: [Param] -> ShowS #

type ParamsBS = [(ByteString, ByteString)] #