Reddit.Types.Reddit

Documentation

type Reddit a = RedditT IO a

newtype RedditT m a

Constructors

RedditT (FreeT (RedditF m) m a)

Instances

MonadTrans RedditT

Defined in Reddit.Types.Reddit

Methods

lift :: Monad m => m a -> RedditT m a

Monad m => Monad (RedditT m)

Defined in Reddit.Types.Reddit

Methods

(>>=) :: RedditT m a -> (a -> RedditT m b) -> RedditT m b

(>>) :: RedditT m a -> RedditT m b -> RedditT m b

return :: a -> RedditT m a

Monad m => Functor (RedditT m)

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> RedditT m a -> RedditT m b

(<$) :: a -> RedditT m b -> RedditT m a

Monad m => Applicative (RedditT m)

Defined in Reddit.Types.Reddit

Methods

pure :: a -> RedditT m a

(<*>) :: RedditT m (a -> b) -> RedditT m a -> RedditT m b

liftA2 :: (a -> b -> c) -> RedditT m a -> RedditT m b -> RedditT m c

(*>) :: RedditT m a -> RedditT m b -> RedditT m b

(<*) :: RedditT m a -> RedditT m b -> RedditT m a

MonadIO m => MonadIO (RedditT m)

Defined in Reddit.Types.Reddit

Methods

liftIO :: IO a -> RedditT m a

data RedditF m a where

Constructors

FailWith :: APIError RedditError -> RedditF m a

Nest :: RedditT m b -> (Either (APIError RedditError) b -> a) -> RedditF m a

NestResuming :: RedditT m b -> (Either (APIError RedditError, Maybe (RedditT m b)) b -> a) -> RedditF m a

ReceiveRoute :: Receivable b => Route -> (b -> a) -> RedditF m a

RunRoute :: FromJSON b => Route -> (b -> a) -> RedditF m a

WithBaseURL :: Text -> RedditT m b -> (b -> a) -> RedditF m a

WithHeaders :: ([Header] -> [Header]) -> RedditT m b -> (b -> a) -> RedditF m a

Instances

Functor (RedditF m)

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> RedditF m a -> RedditF m b

(<$) :: a -> RedditF m b -> RedditF m a

runRoute :: (FromJSON a, Monad m) => Route -> RedditT m a

receiveRoute :: (Receivable a, Monad m) => Route -> RedditT m a

nest :: Monad m => RedditT m a -> RedditT m (Either (APIError RedditError) a)

failWith :: Monad m => APIError RedditError -> RedditT m a

withBaseURL :: Monad m => Text -> RedditT m a -> RedditT m a

withHeaders :: Monad m => ([Header] -> [Header]) -> RedditT m a -> RedditT m a

newtype Modhash

Constructors

Modhash Text

Instances

Eq Modhash

Defined in Reddit.Types.Reddit

Methods

(==) :: Modhash -> Modhash -> Bool

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

Read Modhash

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS Modhash

readList :: ReadS [Modhash]

readPrec :: ReadPrec Modhash

readListPrec :: ReadPrec [Modhash]

Show Modhash

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> Modhash -> ShowS

show :: Modhash -> String

showList :: [Modhash] -> ShowS

FromJSON Modhash

Defined in Reddit.Types.Reddit

Methods

parseJSON :: Value -> Parser Modhash

parseJSONList :: Value -> Parser [Modhash]

data LoginDetails

Constructors

LoginDetails Modhash CookieJar

Instances

Show LoginDetails

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> LoginDetails -> ShowS

show :: LoginDetails -> String

showList :: [LoginDetails] -> ShowS

Receivable LoginDetails

Defined in Reddit.Types.Reddit

Methods

receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) LoginDetails

newtype POSTWrapped a

Constructors

POSTWrapped a

Instances

Functor POSTWrapped

Defined in Reddit.Types.Reddit

Methods

fmap :: (a -> b) -> POSTWrapped a -> POSTWrapped b

(<$) :: a -> POSTWrapped b -> POSTWrapped a

Eq a => Eq (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

(==) :: POSTWrapped a -> POSTWrapped a -> Bool

(/=) :: POSTWrapped a -> POSTWrapped a -> Bool

Read a => Read (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS (POSTWrapped a)

readList :: ReadS [POSTWrapped a]

readPrec :: ReadPrec (POSTWrapped a)

readListPrec :: ReadPrec [POSTWrapped a]

Show a => Show (POSTWrapped a)

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> POSTWrapped a -> ShowS

show :: POSTWrapped a -> String

showList :: [POSTWrapped a] -> ShowS

FromJSON (POSTWrapped [CommentReference])

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped [CommentReference])

parseJSONList :: Value -> Parser [POSTWrapped [CommentReference]]

FromJSON (POSTWrapped CaptchaID)

Defined in Reddit.Types.Captcha

Methods

parseJSON :: Value -> Parser (POSTWrapped CaptchaID)

parseJSONList :: Value -> Parser [POSTWrapped CaptchaID]

FromJSON (POSTWrapped PostID)

Defined in Reddit.Types.Post

Methods

parseJSON :: Value -> Parser (POSTWrapped PostID)

parseJSONList :: Value -> Parser [POSTWrapped PostID]

FromJSON (POSTWrapped Comment)

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped Comment)

parseJSONList :: Value -> Parser [POSTWrapped Comment]

FromJSON (POSTWrapped CommentID)

Defined in Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser (POSTWrapped CommentID)

parseJSONList :: Value -> Parser [POSTWrapped CommentID]

FromJSON (POSTWrapped MessageID)

Defined in Reddit.Types.Message

Methods

parseJSON :: Value -> Parser (POSTWrapped MessageID)

parseJSONList :: Value -> Parser [POSTWrapped MessageID]

type ShouldRateLimit = Bool

data RateLimits

Constructors

RateLimits

Fields

• should :: ShouldRateLimit
• info :: Maybe RateLimitInfo

Instances

Eq RateLimits

Defined in Reddit.Types.Reddit

Methods

(==) :: RateLimits -> RateLimits -> Bool

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

Read RateLimits

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS RateLimits

readList :: ReadS [RateLimits]

readPrec :: ReadPrec RateLimits

readListPrec :: ReadPrec [RateLimits]

Show RateLimits

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> RateLimits -> ShowS

show :: RateLimits -> String

showList :: [RateLimits] -> ShowS

data RateLimitInfo

Constructors

RateLimitInfo

Fields

• used :: Integer
• remaining :: Integer
• resetTime :: UTCTime

Instances

Eq RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

(==) :: RateLimitInfo -> RateLimitInfo -> Bool

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

Read RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS RateLimitInfo

readList :: ReadS [RateLimitInfo]

readPrec :: ReadPrec RateLimitInfo

readListPrec :: ReadPrec [RateLimitInfo]

Show RateLimitInfo

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> RateLimitInfo -> ShowS

show :: RateLimitInfo -> String

showList :: [RateLimitInfo] -> ShowS

headersToRateLimitInfo :: ResponseHeaders -> UTCTime -> Maybe RateLimitInfo

data ClientParams

Constructors

ClientParams Text Text

Instances

Eq ClientParams

Defined in Reddit.Types.Reddit

Methods

(==) :: ClientParams -> ClientParams -> Bool

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

Ord ClientParams

Defined in Reddit.Types.Reddit

Methods

compare :: ClientParams -> ClientParams -> Ordering

(<) :: ClientParams -> ClientParams -> Bool

(<=) :: ClientParams -> ClientParams -> Bool

(>) :: ClientParams -> ClientParams -> Bool

(>=) :: ClientParams -> ClientParams -> Bool

max :: ClientParams -> ClientParams -> ClientParams

min :: ClientParams -> ClientParams -> ClientParams

Read ClientParams

Defined in Reddit.Types.Reddit

Methods

readsPrec :: Int -> ReadS ClientParams

readList :: ReadS [ClientParams]

readPrec :: ReadPrec ClientParams

readListPrec :: ReadPrec [ClientParams]

Show ClientParams

Defined in Reddit.Types.Reddit

Methods

showsPrec :: Int -> ClientParams -> ShowS

show :: ClientParams -> String

showList :: [ClientParams] -> ShowS

mkClientParamsHeader :: ClientParams -> (HeaderName, ByteString)

mainBaseURL :: Text

loginBaseURL :: Text

addAPIType :: Route -> Route