Pinboard.Types

Documentation

type PinboardEnv = (PinboardConfig, Manager)

type PinboardT m a = ReaderT PinboardEnv (LoggingT m) a

runPinboardT :: MonadUnliftIO m => PinboardEnv -> PinboardT m a -> m a

type MonadPinboard m = (MonadUnliftIO 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

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

Defined in Pinboard.Types

Methods

showsPrec :: Int -> PinboardRequest -> ShowS

show :: PinboardRequest -> String

showList :: [PinboardRequest] -> ShowS

data ResultFormatType

Constructors

FormatJson

FormatXml

Instances

Eq ResultFormatType

Defined in Pinboard.Types

Methods

(==) :: ResultFormatType -> ResultFormatType -> Bool

(/=) :: ResultFormatType -> ResultFormatType -> Bool

Show ResultFormatType

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

Defined in Pinboard.Types

Methods

(==) :: Param -> Param -> Bool

(/=) :: Param -> Param -> Bool

Show Param

Defined in Pinboard.Types

Methods

showsPrec :: Int -> Param -> ShowS

show :: Param -> String

showList :: [Param] -> ShowS

type ParamsBS = [(ByteString, ByteString)]