Pinboard.Client

Config

fromApiToken :: String -> PinboardConfig

Create a default PinboardConfig using the supplied apiToken

The PinboardConfig provides authentication via apiToken

data PinboardConfig

Constructors

PinboardConfig

Fields

apiToken :: ByteString

debug :: Bool

Instances

Show PinboardConfig

Monadic

runPinboard :: PinboardConfig -> Pinboard a -> IO (Either PinboardError a)

Execute computations in the Pinboard monad

pinboardJson :: FromJSON a => PinboardRequest -> Pinboard a

Create a Pinboard value from a PinboardRequest w/ json deserialization

Single

runPinboardSingleRaw :: PinboardConfig -> PinboardRequest -> (Response -> InputStream ByteString -> IO a) -> IO (Either PinboardError a)

runPinboardSingleRawBS :: PinboardConfig -> PinboardRequest -> IO (Either PinboardError ByteString)

runPinboardSingleJson :: FromJSON a => PinboardConfig -> PinboardRequest -> IO (Either PinboardError a)

Sending

sendPinboardRequest :: PinboardRequest -> PinboardConfig -> Connection -> (Response -> InputStream ByteString -> IO a) -> IO a

sendPinboardRequestBS :: PinboardRequest -> PinboardConfig -> Connection -> IO (Response, ByteString)

Connections

connOpenRaw :: IO Connection

connOpen :: IO (Either SomeException Connection)

connClose :: Either a Connection -> IO ()

connFail :: PinboardErrorType -> SomeException -> IO (Either PinboardError b)

JSON Streams

parseJSONResponseStream :: FromJSON a => Response -> InputStream ByteString -> IO (Response, Either PinboardError a)

parseJSONFromStream :: FromJSON a => InputStream ByteString -> IO (Either PinboardError a)

Status Codes

checkStatusCode :: StatusCode -> Either PinboardError ()

Error Helpers

addErrMsg :: Text -> PinboardError -> PinboardError

createParserErr :: Text -> PinboardError

httpStatusPinboardError :: PinboardErrorHTTPCode -> Either PinboardError a

Client Dependencies

module Pinboard.Client.Error

module Pinboard.Client.Types

module Pinboard.Client.Util