Web.Pixiv.Types.PixivT

The core monad of this library. PixivT maintains a pixiv login state, and provides an environment to perform computations created by servant.

ClientT monad transformer

newtype ClientT m a

Transformer version of ClientM, changing the base IO to m.

Constructors

ClientT

Fields

• unClientT :: ReaderT ClientEnv (ExceptT ClientError m) a

Instances

MonadTrans ClientT

Defined in Web.Pixiv.Types.PixivT

Methods

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

Monad m => MonadReader ClientEnv (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

ask :: ClientT m ClientEnv

local :: (ClientEnv -> ClientEnv) -> ClientT m a -> ClientT m a

reader :: (ClientEnv -> a) -> ClientT m a

Monad m => MonadError ClientError (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

throwError :: ClientError -> ClientT m a

catchError :: ClientT m a -> (ClientError -> ClientT m a) -> ClientT m a

MonadBase b m => MonadBase b (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

liftBase :: b α -> ClientT m α

MonadBaseControl b m => MonadBaseControl b (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Associated Types

type StM (ClientT m) a

Methods

liftBaseWith :: (RunInBase (ClientT m) b -> b a) -> ClientT m a

restoreM :: StM (ClientT m) a -> ClientT m a

Monad m => Monad (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

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

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

return :: a -> ClientT m a

Functor m => Functor (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

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

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

Monad m => Applicative (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

pure :: a -> ClientT m a

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

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

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

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

MonadIO m => MonadIO (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

liftIO :: IO a -> ClientT m a

MonadThrow m => MonadThrow (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

throwM :: Exception e => e -> ClientT m a

MonadCatch m => MonadCatch (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

catch :: Exception e => ClientT m a -> (e -> ClientT m a) -> ClientT m a

MonadIO m => RunClient (ClientT m)

Defined in Web.Pixiv.Types.PixivT

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> ClientT m Response

throwClientError :: ClientError -> ClientT m a

type StM (ClientT m) a

Defined in Web.Pixiv.Types.PixivT

type StM (ClientT m) a = StM (ReaderT ClientEnv (ExceptT ClientError m)) a

runClientT :: ClientEnv -> ClientT m a -> m (Either ClientError a)

Executes a computation in the client monad.

mkDefaultClientEnv :: Manager -> IO ClientEnv

Given Manager, creates a ClientEnv using https://app-api.pixiv.net as base url.

MonadPixiv class

class (RunClient m, MonadIO m) => MonadPixiv m where

The mtl-style class of pixiv monad.

Methods

takePixivState :: m PixivState

Reads the stored PixivState, when used in a multithreaded setting, this should block all other thread from reading the PixivState until putPixivState is called.

putPixivState :: PixivState -> m ()

Writes a new PixivState.

readPixivState :: m PixivState

Reads the stored PixivState, without blocking other threads which want to read this state.

Don't confuse with takePixivState, please refer to readMVar.

Instances

(MonadPixiv m, MonadTrans f, MonadIO (f m), RunClient (f m)) => MonadPixiv (f m)

Defined in Web.Pixiv.Types.PixivT

Methods

takePixivState :: f m PixivState

putPixivState :: PixivState -> f m ()

readPixivState :: f m PixivState

MonadIO m => MonadPixiv (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

takePixivState :: PixivT m PixivState

putPixivState :: PixivState -> PixivT m ()

readPixivState :: PixivT m PixivState

data PixivState

State stored in MonadPixiv.

Constructors

PixivState

Fields

• tokenState :: TokenState
• acceptLanguage :: Maybe Text

Instances

Show PixivState

Defined in Web.Pixiv.Types.PixivT

Methods

showsPrec :: Int -> PixivState -> ShowS

show :: PixivState -> String

showList :: [PixivState] -> ShowS

Generic PixivState

Defined in Web.Pixiv.Types.PixivT

Associated Types

type Rep PixivState :: Type -> Type

Methods

from :: PixivState -> Rep PixivState x

to :: Rep PixivState x -> PixivState

Monad m => MonadReader (MVar PixivState) (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

ask :: PixivT m (MVar PixivState)

local :: (MVar PixivState -> MVar PixivState) -> PixivT m a -> PixivT m a

reader :: (MVar PixivState -> a) -> PixivT m a

type Rep PixivState

Defined in Web.Pixiv.Types.PixivT

type Rep PixivState = D1 ('MetaData "PixivState" "Web.Pixiv.Types.PixivT" "pixiv-0.1.0-GCIxdtj9s9mI3K1NC86k4F" 'False) (C1 ('MetaCons "PixivState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tokenState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenState) :*: S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

PixivT monad transformer

newtype PixivT m a

A thread safe implementation of MonadPixiv.

Constructors

PixivT

Fields

• unPixivT :: ReaderT (MVar PixivState) (ClientT m) a

Instances

MonadTrans PixivT

Defined in Web.Pixiv.Types.PixivT

Methods

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

Monad m => MonadError ClientError (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

throwError :: ClientError -> PixivT m a

catchError :: PixivT m a -> (ClientError -> PixivT m a) -> PixivT m a

MonadBase IO m => MonadBase IO (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

liftBase :: IO α -> PixivT m α

MonadBaseControl IO m => MonadBaseControl IO (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Associated Types

type StM (PixivT m) a

Methods

liftBaseWith :: (RunInBase (PixivT m) IO -> IO a) -> PixivT m a

restoreM :: StM (PixivT m) a -> PixivT m a

Monad m => Monad (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

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

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

return :: a -> PixivT m a

Functor m => Functor (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

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

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

Monad m => Applicative (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

pure :: a -> PixivT m a

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

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

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

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

MonadIO m => MonadIO (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

liftIO :: IO a -> PixivT m a

MonadThrow m => MonadThrow (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

throwM :: Exception e => e -> PixivT m a

MonadCatch m => MonadCatch (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

catch :: Exception e => PixivT m a -> (e -> PixivT m a) -> PixivT m a

MonadIO m => RunClient (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> PixivT m Response

throwClientError :: ClientError -> PixivT m a

MonadIO m => MonadPixiv (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

takePixivState :: PixivT m PixivState

putPixivState :: PixivState -> PixivT m ()

readPixivState :: PixivT m PixivState

Monad m => MonadReader (MVar PixivState) (PixivT m)

Defined in Web.Pixiv.Types.PixivT

Methods

ask :: PixivT m (MVar PixivState)

local :: (MVar PixivState -> MVar PixivState) -> PixivT m a -> PixivT m a

reader :: (MVar PixivState -> a) -> PixivT m a

Generic (PixivT m a)

Defined in Web.Pixiv.Types.PixivT

Associated Types

type Rep (PixivT m a) :: Type -> Type

Methods

from :: PixivT m a -> Rep (PixivT m a) x

to :: Rep (PixivT m a) x -> PixivT m a

type StM (PixivT m) a

Defined in Web.Pixiv.Types.PixivT

type StM (PixivT m) a = StM (ReaderT (MVar PixivState) (ClientT m)) a

type Rep (PixivT m a)

Defined in Web.Pixiv.Types.PixivT

type Rep (PixivT m a) = D1 ('MetaData "PixivT" "Web.Pixiv.Types.PixivT" "pixiv-0.1.0-GCIxdtj9s9mI3K1NC86k4F" 'True) (C1 ('MetaCons "PixivT" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPixivT") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReaderT (MVar PixivState) (ClientT m) a))))

liftC :: Monad m => ClientT m a -> PixivT m a

Lifts a computation in ClientT to PixivT.

runPixivT :: MonadIO m => Manager -> Credential -> PixivT m a -> m (Either ClientError a)

Interprets the PixivT effect, with a supplied Manager.

runPixivT' :: MonadIO m => Credential -> PixivT m a -> m (Either ClientError a)

Like runPixivT, but creates a new Manager everytime.

Token

data TokenState

Pixiv auth state.

Constructors

TokenState

Fields

• accessToken :: Token

  Token to access pixiv api.

• refreshToken :: Token

  Token to obtain new accessToken without giving username and password.

• expirationTime :: UTCTime

  Time stamp when accessToken becomes invalid.

• manager :: Manager

Instances

Show TokenState

Defined in Web.Pixiv.Types.PixivT

Methods

showsPrec :: Int -> TokenState -> ShowS

show :: TokenState -> String

showList :: [TokenState] -> ShowS

Generic TokenState

Defined in Web.Pixiv.Types.PixivT

Associated Types

type Rep TokenState :: Type -> Type

Methods

from :: TokenState -> Rep TokenState x

to :: Rep TokenState x -> TokenState

type Rep TokenState

Defined in Web.Pixiv.Types.PixivT

type Rep TokenState = D1 ('MetaData "TokenState" "Web.Pixiv.Types.PixivT" "pixiv-0.1.0-GCIxdtj9s9mI3K1NC86k4F" 'False) (C1 ('MetaCons "TokenState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token) :*: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Token)) :*: (S1 ('MetaSel ('Just "expirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "manager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Manager))))

computeTokenState

Arguments

:: Manager

-> Credential

Could be username with password or refreshToken.

-> UTCTime

Current time.

-> IO TokenState

Computes the TokenState.

This function calls auth' to perform authentication.

Utilities

getAccessToken :: MonadPixiv m => m Token

Retrieves the accessToken from pixiv monad.

If the token is overdue, it will call computeTokenState to refresh.

getAccessTokenWithAccpetLanguage :: MonadPixiv m => m (Token, Maybe Text)

Retrieves the accessToken and acceptLanguage in one go.