Web.Twitter.Conduit.Cursor

Documentation

class CursorKey a where

Minimal complete definition

cursorKey

Methods

cursorKey :: a -> Text

Instances

CursorKey ListsCursorKey

Methods

cursorKey :: ListsCursorKey -> Text

CursorKey UsersCursorKey

Methods

cursorKey :: UsersCursorKey -> Text

CursorKey IdsCursorKey

Methods

cursorKey :: IdsCursorKey -> Text

data IdsCursorKey

Phantom type to specify the key which point out the content in the response.

Instances

CursorKey IdsCursorKey

Methods

cursorKey :: IdsCursorKey -> Text

data UsersCursorKey

Phantom type to specify the key which point out the content in the response.

Instances

CursorKey UsersCursorKey

Methods

cursorKey :: UsersCursorKey -> Text

data ListsCursorKey

Phantom type to specify the key which point out the content in the response.

Instances

CursorKey ListsCursorKey

Methods

cursorKey :: ListsCursorKey -> Text

data WithCursor cursorKey wrapped

A wrapper for API responses which have "next_cursor" field.

The first type parameter of WithCursor specifies the field name of contents.

>>> let Just res = decode "{\"previous_cursor\": 0, \"next_cursor\": 1234567890, \"ids\": [1111111111]}" :: Maybe (WithCursor IdsCursorKey UserId)
>>> nextCursor res
1234567890
>>> contents res
[1111111111]

>>> let Just res = decode "{\"previous_cursor\": 0, \"next_cursor\": 0, \"users\": [1000]}" :: Maybe (WithCursor UsersCursorKey UserId)
>>> nextCursor res
0
>>> contents res
[1000]

Constructors

WithCursor

Fields

• previousCursor :: Integer
• nextCursor :: Integer
• contents :: [wrapped]

Instances

Show wrapped => Show (WithCursor cursorKey wrapped)

Methods

showsPrec :: Int -> WithCursor cursorKey wrapped -> ShowS

show :: WithCursor cursorKey wrapped -> String

showList :: [WithCursor cursorKey wrapped] -> ShowS

(FromJSON wrapped, CursorKey c) => FromJSON (WithCursor c wrapped)

Methods

parseJSON :: Value -> Parser (WithCursor c wrapped)

parseJSONList :: Value -> Parser [WithCursor c wrapped]