Safe Haskell	None
Language	Haskell2010

Reddit.Types

Documentation

newtype CaptchaID Source #

Constructors

CaptchaID Text

Instances

Eq CaptchaID Source #
Methods (==) :: CaptchaID -> CaptchaID -> Bool # (/=) :: CaptchaID -> CaptchaID -> Bool #
Ord CaptchaID Source #
Methods compare :: CaptchaID -> CaptchaID -> Ordering # (<) :: CaptchaID -> CaptchaID -> Bool # (<=) :: CaptchaID -> CaptchaID -> Bool # (>) :: CaptchaID -> CaptchaID -> Bool # (>=) :: CaptchaID -> CaptchaID -> Bool # max :: CaptchaID -> CaptchaID -> CaptchaID # min :: CaptchaID -> CaptchaID -> CaptchaID #
Read CaptchaID Source #
Methods readsPrec :: Int -> ReadS CaptchaID # readList :: ReadS [CaptchaID] # readPrec :: ReadPrec CaptchaID # readListPrec :: ReadPrec [CaptchaID] #
Show CaptchaID Source #
Methods showsPrec :: Int -> CaptchaID -> ShowS # show :: CaptchaID -> String # showList :: [CaptchaID] -> ShowS #
FromJSON CaptchaID Source #
Methods parseJSON :: Value -> Parser CaptchaID # parseJSONList :: Value -> Parser [CaptchaID] #
FromJSON (POSTWrapped CaptchaID) Source #
Methods parseJSON :: Value -> Parser (POSTWrapped CaptchaID) # parseJSONList :: Value -> Parser [POSTWrapped CaptchaID] #

data Comment Source #

Instances

Eq Comment Source #
Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Read Comment Source #
Methods readsPrec :: Int -> ReadS Comment # readList :: ReadS [Comment] # readPrec :: ReadPrec Comment # readListPrec :: ReadPrec [Comment] #
Show Comment Source #
Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #
FromJSON Comment Source #
Methods parseJSON :: Value -> Parser Comment # parseJSONList :: Value -> Parser [Comment] #
Thing Comment Source #
Methods fullName :: Comment -> Text Source #
FromJSON (POSTWrapped Comment) Source #
Methods parseJSON :: Value -> Parser (POSTWrapped Comment) # parseJSONList :: Value -> Parser [POSTWrapped Comment] #

newtype CommentID Source #

Constructors

CommentID Text

Instances

Eq CommentID Source #
Methods (==) :: CommentID -> CommentID -> Bool # (/=) :: CommentID -> CommentID -> Bool #
Ord CommentID Source #
Methods compare :: CommentID -> CommentID -> Ordering # (<) :: CommentID -> CommentID -> Bool # (<=) :: CommentID -> CommentID -> Bool # (>) :: CommentID -> CommentID -> Bool # (>=) :: CommentID -> CommentID -> Bool # max :: CommentID -> CommentID -> CommentID # min :: CommentID -> CommentID -> CommentID #
Read CommentID Source #
Methods readsPrec :: Int -> ReadS CommentID # readList :: ReadS [CommentID] # readPrec :: ReadPrec CommentID # readListPrec :: ReadPrec [CommentID] #
Show CommentID Source #
Methods showsPrec :: Int -> CommentID -> ShowS # show :: CommentID -> String # showList :: [CommentID] -> ShowS #
FromJSON CommentID Source #
Methods parseJSON :: Value -> Parser CommentID # parseJSONList :: Value -> Parser [CommentID] #
ToQuery CommentID Source #
Methods toQuery :: Text -> CommentID -> [(Text, Text)] #
Thing CommentID Source #
Methods fullName :: CommentID -> Text Source #
FromJSON (POSTWrapped CommentID) Source #
Methods parseJSON :: Value -> Parser (POSTWrapped CommentID) # parseJSONList :: Value -> Parser [POSTWrapped CommentID] #

type CommentListing = Listing CommentID Comment Source #

data Listing t a Source #

Constructors

Listing
Fields before :: Maybe t after :: Maybe t contents :: [a]

Instances

Functor (Listing t) Source #
Methods fmap :: (a -> b) -> Listing t a -> Listing t b # (<$) :: a -> Listing t b -> Listing t a #
(Eq a, Eq t) => Eq (Listing t a) Source #
Methods (==) :: Listing t a -> Listing t a -> Bool # (/=) :: Listing t a -> Listing t a -> Bool #
(Read a, Read t) => Read (Listing t a) Source #
Methods readsPrec :: Int -> ReadS (Listing t a) # readList :: ReadS [Listing t a] # readPrec :: ReadPrec (Listing t a) # readListPrec :: ReadPrec [Listing t a] #
(Show a, Show t) => Show (Listing t a) Source #
Methods showsPrec :: Int -> Listing t a -> ShowS # show :: Listing t a -> String # showList :: [Listing t a] -> ShowS #
Ord t => Monoid (Listing t a) Source #
Methods mempty :: Listing t a # mappend :: Listing t a -> Listing t a -> Listing t a # mconcat :: [Listing t a] -> Listing t a #
(FromJSON t, FromJSON a) => FromJSON (Listing t a) Source #
Methods parseJSON :: Value -> Parser (Listing t a) # parseJSONList :: Value -> Parser [Listing t a] #

data LoginDetails Source #

Instances

Eq LoginDetails Source #
Methods (==) :: LoginDetails -> LoginDetails -> Bool # (/=) :: LoginDetails -> LoginDetails -> Bool #
Show LoginDetails Source #
Methods showsPrec :: Int -> LoginDetails -> ShowS # show :: LoginDetails -> String # showList :: [LoginDetails] -> ShowS #
Receivable LoginDetails Source #
Methods receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) LoginDetails #

data Message Source #

Instances

Eq Message Source #
Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Read Message Source #
Methods readsPrec :: Int -> ReadS Message # readList :: ReadS [Message] # readPrec :: ReadPrec Message # readListPrec :: ReadPrec [Message] #
Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
FromJSON Message Source #
Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
ToQuery Message Source #
Methods toQuery :: Text -> Message -> [(Text, Text)] #
Thing Message Source #
Methods fullName :: Message -> Text Source #

data MessageID Source #

Constructors

MessageID Text

Instances

Eq MessageID Source #
Methods (==) :: MessageID -> MessageID -> Bool # (/=) :: MessageID -> MessageID -> Bool #
Ord MessageID Source #
Methods compare :: MessageID -> MessageID -> Ordering # (<) :: MessageID -> MessageID -> Bool # (<=) :: MessageID -> MessageID -> Bool # (>) :: MessageID -> MessageID -> Bool # (>=) :: MessageID -> MessageID -> Bool # max :: MessageID -> MessageID -> MessageID # min :: MessageID -> MessageID -> MessageID #
Read MessageID Source #
Methods readsPrec :: Int -> ReadS MessageID # readList :: ReadS [MessageID] # readPrec :: ReadPrec MessageID # readListPrec :: ReadPrec [MessageID] #
Show MessageID Source #
Methods showsPrec :: Int -> MessageID -> ShowS # show :: MessageID -> String # showList :: [MessageID] -> ShowS #
FromJSON MessageID Source #
Methods parseJSON :: Value -> Parser MessageID # parseJSONList :: Value -> Parser [MessageID] #
ToQuery MessageID Source #
Methods toQuery :: Text -> MessageID -> [(Text, Text)] #
Thing MessageID Source #
Methods fullName :: MessageID -> Text Source #
FromJSON (POSTWrapped MessageID) Source #
Methods parseJSON :: Value -> Parser (POSTWrapped MessageID) # parseJSONList :: Value -> Parser [POSTWrapped MessageID] #

data MessageKind Source #

Constructors

CommentMessage CommentID
PrivateMessage MessageID

Instances

Eq MessageKind Source #
Methods (==) :: MessageKind -> MessageKind -> Bool # (/=) :: MessageKind -> MessageKind -> Bool #
Ord MessageKind Source #
Methods compare :: MessageKind -> MessageKind -> Ordering # (<) :: MessageKind -> MessageKind -> Bool # (<=) :: MessageKind -> MessageKind -> Bool # (>) :: MessageKind -> MessageKind -> Bool # (>=) :: MessageKind -> MessageKind -> Bool # max :: MessageKind -> MessageKind -> MessageKind # min :: MessageKind -> MessageKind -> MessageKind #
Read MessageKind Source #
Methods readsPrec :: Int -> ReadS MessageKind # readList :: ReadS [MessageKind] # readPrec :: ReadPrec MessageKind # readListPrec :: ReadPrec [MessageKind] #
Show MessageKind Source #
Methods showsPrec :: Int -> MessageKind -> ShowS # show :: MessageKind -> String # showList :: [MessageKind] -> ShowS #
FromJSON MessageKind Source #
Methods parseJSON :: Value -> Parser MessageKind # parseJSONList :: Value -> Parser [MessageKind] #
ToQuery MessageKind Source #
Methods toQuery :: Text -> MessageKind -> [(Text, Text)] #
Thing MessageKind Source #
Methods fullName :: MessageKind -> Text Source #

data Modhash Source #

Instances

Eq Modhash Source #
Methods (==) :: Modhash -> Modhash -> Bool # (/=) :: Modhash -> Modhash -> Bool #
Read Modhash Source #
Methods readsPrec :: Int -> ReadS Modhash # readList :: ReadS [Modhash] # readPrec :: ReadPrec Modhash # readListPrec :: ReadPrec [Modhash] #
Show Modhash Source #
Methods showsPrec :: Int -> Modhash -> ShowS # show :: Modhash -> String # showList :: [Modhash] -> ShowS #
FromJSON Modhash Source #
Methods parseJSON :: Value -> Parser Modhash # parseJSONList :: Value -> Parser [Modhash] #

data Options a Source #

Constructors

Options
Fields pagination :: Maybe (PaginationOption a) limit :: Maybe Int

Instances

Eq a => Eq (Options a) Source #
Methods (==) :: Options a -> Options a -> Bool # (/=) :: Options a -> Options a -> Bool #
Read a => Read (Options a) Source #
Methods readsPrec :: Int -> ReadS (Options a) # readList :: ReadS [Options a] # readPrec :: ReadPrec (Options a) # readListPrec :: ReadPrec [Options a] #
Show a => Show (Options a) Source #
Methods showsPrec :: Int -> Options a -> ShowS # show :: Options a -> String # showList :: [Options a] -> ShowS #
Default (Options a) Source #
Methods def :: Options a #

data PaginationOption a Source #

Constructors

Before a
After a

Instances

Eq a => Eq (PaginationOption a) Source #
Methods (==) :: PaginationOption a -> PaginationOption a -> Bool # (/=) :: PaginationOption a -> PaginationOption a -> Bool #
Read a => Read (PaginationOption a) Source #
Methods readsPrec :: Int -> ReadS (PaginationOption a) # readList :: ReadS [PaginationOption a] # readPrec :: ReadPrec (PaginationOption a) # readListPrec :: ReadPrec [PaginationOption a] #
Show a => Show (PaginationOption a) Source #
Methods showsPrec :: Int -> PaginationOption a -> ShowS # show :: PaginationOption a -> String # showList :: [PaginationOption a] -> ShowS #

data Post Source #

Instances

Eq Post Source #
Methods (==) :: Post -> Post -> Bool # (/=) :: Post -> Post -> Bool #
Read Post Source #
Methods readsPrec :: Int -> ReadS Post # readList :: ReadS [Post] # readPrec :: ReadPrec Post # readListPrec :: ReadPrec [Post] #
Show Post Source #
Methods showsPrec :: Int -> Post -> ShowS # show :: Post -> String # showList :: [Post] -> ShowS #
FromJSON Post Source #
Methods parseJSON :: Value -> Parser Post # parseJSONList :: Value -> Parser [Post] #
Thing Post Source #
Methods fullName :: Post -> Text Source #

data PostContent Source #

Constructors

SelfPost Text Text
Link Text
TitleOnly

Instances

Eq PostContent Source #
Methods (==) :: PostContent -> PostContent -> Bool # (/=) :: PostContent -> PostContent -> Bool #
Read PostContent Source #
Methods readsPrec :: Int -> ReadS PostContent # readList :: ReadS [PostContent] # readPrec :: ReadPrec PostContent # readListPrec :: ReadPrec [PostContent] #
Show PostContent Source #
Methods showsPrec :: Int -> PostContent -> ShowS # show :: PostContent -> String # showList :: [PostContent] -> ShowS #

newtype PostID Source #

Constructors

PostID Text

Instances

Eq PostID Source #
Methods (==) :: PostID -> PostID -> Bool # (/=) :: PostID -> PostID -> Bool #
Ord PostID Source #
Methods compare :: PostID -> PostID -> Ordering # (<) :: PostID -> PostID -> Bool # (<=) :: PostID -> PostID -> Bool # (>) :: PostID -> PostID -> Bool # (>=) :: PostID -> PostID -> Bool # max :: PostID -> PostID -> PostID # min :: PostID -> PostID -> PostID #
Read PostID Source #
Methods readsPrec :: Int -> ReadS PostID # readList :: ReadS [PostID] # readPrec :: ReadPrec PostID # readListPrec :: ReadPrec [PostID] #
Show PostID Source #
Methods showsPrec :: Int -> PostID -> ShowS # show :: PostID -> String # showList :: [PostID] -> ShowS #
FromJSON PostID Source #
Methods parseJSON :: Value -> Parser PostID # parseJSONList :: Value -> Parser [PostID] #
ToQuery PostID Source #
Methods toQuery :: Text -> PostID -> [(Text, Text)] #
Thing PostID Source #
Methods fullName :: PostID -> Text Source #
FromJSON (POSTWrapped PostID) Source #
Methods parseJSON :: Value -> Parser (POSTWrapped PostID) # parseJSONList :: Value -> Parser [POSTWrapped PostID] #

type PostListing = Listing PostID Post Source #

type Reddit a = RedditT IO a Source #

data RedditError Source #

Instances

Eq RedditError Source #
Methods (==) :: RedditError -> RedditError -> Bool # (/=) :: RedditError -> RedditError -> Bool #
Show RedditError Source #
Methods showsPrec :: Int -> RedditError -> ShowS # show :: RedditError -> String # showList :: [RedditError] -> ShowS #
FromJSON RedditError Source #
Methods parseJSON :: Value -> Parser RedditError # parseJSONList :: Value -> Parser [RedditError] #
ErrorReceivable RedditError Source #
Methods receiveError :: Response ByteString -> Maybe RedditError #

data RedditT m a Source #

Instances

MonadTrans RedditT Source #
Methods lift :: Monad m => m a -> RedditT m a #
Monad m => Monad (RedditT m) Source #
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 # fail :: String -> RedditT m a #
Monad m => Functor (RedditT m) Source #
Methods fmap :: (a -> b) -> RedditT m a -> RedditT m b # (<$) :: a -> RedditT m b -> RedditT m a #
Monad m => Applicative (RedditT m) Source #
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) Source #
Methods liftIO :: IO a -> RedditT m a #

data Subreddit Source #

Instances

Eq Subreddit Source #
Methods (==) :: Subreddit -> Subreddit -> Bool # (/=) :: Subreddit -> Subreddit -> Bool #
Show Subreddit Source #
Methods showsPrec :: Int -> Subreddit -> ShowS # show :: Subreddit -> String # showList :: [Subreddit] -> ShowS #
FromJSON Subreddit Source #
Methods parseJSON :: Value -> Parser Subreddit # parseJSONList :: Value -> Parser [Subreddit] #
Thing Subreddit Source #
Methods fullName :: Subreddit -> Text Source #

newtype SubredditName Source #

Constructors

R Text

Instances

Eq SubredditName Source #
Methods (==) :: SubredditName -> SubredditName -> Bool # (/=) :: SubredditName -> SubredditName -> Bool #
Ord SubredditName Source #
Methods compare :: SubredditName -> SubredditName -> Ordering # (<) :: SubredditName -> SubredditName -> Bool # (<=) :: SubredditName -> SubredditName -> Bool # (>) :: SubredditName -> SubredditName -> Bool # (>=) :: SubredditName -> SubredditName -> Bool # max :: SubredditName -> SubredditName -> SubredditName # min :: SubredditName -> SubredditName -> SubredditName #
Read SubredditName Source #
Methods readsPrec :: Int -> ReadS SubredditName # readList :: ReadS [SubredditName] # readPrec :: ReadPrec SubredditName # readListPrec :: ReadPrec [SubredditName] #
Show SubredditName Source #
Methods showsPrec :: Int -> SubredditName -> ShowS # show :: SubredditName -> String # showList :: [SubredditName] -> ShowS #
FromJSON SubredditName Source #
Methods parseJSON :: Value -> Parser SubredditName # parseJSONList :: Value -> Parser [SubredditName] #
ToQuery SubredditName Source #
Methods toQuery :: Text -> SubredditName -> [(Text, Text)] #

class Thing a Source #

Minimal complete definition

fullName

Instances

Thing Subreddit Source #
Methods fullName :: Subreddit -> Text Source #
Thing SubredditID Source #
Methods fullName :: SubredditID -> Text Source #
Thing UserID Source #
Methods fullName :: UserID -> Text Source #
Thing BanID Source #
Methods fullName :: BanID -> Text Source #
Thing Post Source #
Methods fullName :: Post -> Text Source #
Thing PostID Source #
Methods fullName :: PostID -> Text Source #
Thing Comment Source #
Methods fullName :: Comment -> Text Source #
Thing CommentID Source #
Methods fullName :: CommentID -> Text Source #
Thing MessageKind Source #
Methods fullName :: MessageKind -> Text Source #
Thing MessageID Source #
Methods fullName :: MessageID -> Text Source #
Thing Message Source #
Methods fullName :: Message -> Text Source #

data User Source #

Instances

Eq User Source #
Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
FromJSON User Source #
Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #

newtype Username Source #

Constructors

Username Text

Instances

Eq Username Source #
Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Ord Username Source #
Methods compare :: Username -> Username -> Ordering # (<) :: Username -> Username -> Bool # (<=) :: Username -> Username -> Bool # (>) :: Username -> Username -> Bool # (>=) :: Username -> Username -> Bool # max :: Username -> Username -> Username # min :: Username -> Username -> Username #
Read Username Source #
Methods readsPrec :: Int -> ReadS Username # readList :: ReadS [Username] # readPrec :: ReadPrec Username # readListPrec :: ReadPrec [Username] #
Show Username Source #
Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
FromJSON Username Source #
Methods parseJSON :: Value -> Parser Username # parseJSONList :: Value -> Parser [Username] #
ToQuery Username Source #
Methods toQuery :: Text -> Username -> [(Text, Text)] #

RedditError Object
FailError Text
InvalidResponseError
CaptchaError Text
CredentialsError
RateLimitError Integer Text
NoSubredditSpecified
NoURLSpecified
NoName
NoText Text
AlreadySubmitted
CommentDeleted
LinkDeleted
BadSubredditName
TooManyRequests