| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Krank.Types
Synopsis
- newtype GithubKey = GithubKey Text
- newtype GitlabHost = GitlabHost Text
- newtype GitlabKey = GitlabKey Text
- data Violation = Violation {}
- data ViolationLevel
- data KrankConfig = KrankConfig {}
- data SourcePos = SourcePos {}
- data Localized t = Localized {
- getLocation :: SourcePos
- unLocalized :: t
- class (Monad m, MonadCatch m) => MonadKrank m where
- krankRunRESTRequest :: FromJSON t => Url Https -> Option Https -> m t
- krankAsks :: (KrankConfig -> b) -> m b
- krankMapConcurrently :: (a -> m b) -> [a] -> m [b]
- krankForConcurrently :: [a] -> (a -> m b) -> m [b]
- krankReadFile :: FilePath -> m ByteString
- krankPutStrLnStderr :: Text -> m ()
- krankPutStr :: Text -> m ()
Documentation
newtype GitlabHost Source #
Constructors
| GitlabHost Text |
Instances
| Eq GitlabHost Source # | |
Defined in Krank.Types | |
| Ord GitlabHost Source # | |
Defined in Krank.Types Methods compare :: GitlabHost -> GitlabHost -> Ordering # (<) :: GitlabHost -> GitlabHost -> Bool # (<=) :: GitlabHost -> GitlabHost -> Bool # (>) :: GitlabHost -> GitlabHost -> Bool # (>=) :: GitlabHost -> GitlabHost -> Bool # max :: GitlabHost -> GitlabHost -> GitlabHost # min :: GitlabHost -> GitlabHost -> GitlabHost # | |
| Show GitlabHost Source # | |
Defined in Krank.Types Methods showsPrec :: Int -> GitlabHost -> ShowS # show :: GitlabHost -> String # showList :: [GitlabHost] -> ShowS # | |
Constructors
| Violation | |
Fields
| |
data ViolationLevel Source #
Instances
| Show ViolationLevel Source # | |
Defined in Krank.Types Methods showsPrec :: Int -> ViolationLevel -> ShowS # show :: ViolationLevel -> String # showList :: [ViolationLevel] -> ShowS # | |
data KrankConfig Source #
Constructors
| KrankConfig | |
Instances
| Show KrankConfig Source # | |
Defined in Krank.Types Methods showsPrec :: Int -> KrankConfig -> ShowS # show :: KrankConfig -> String # showList :: [KrankConfig] -> ShowS # | |
Instances
| Eq SourcePos Source # | |
| Ord SourcePos Source # | |
| Show SourcePos Source # | |
Represents a localized chunk of information in a file
Constructors
| Localized | |
Fields
| |
class (Monad m, MonadCatch m) => MonadKrank m where Source #
This monad represents all the effect that Krank needs
Minimal complete definition
krankRunRESTRequest, krankAsks, krankMapConcurrently, krankReadFile, krankPutStrLnStderr, krankPutStr
Methods
krankRunRESTRequest :: FromJSON t => Url Https -> Option Https -> m t Source #
Run a REST requet
krankAsks :: (KrankConfig -> b) -> m b Source #
Read the configuration
krankMapConcurrently :: (a -> m b) -> [a] -> m [b] Source #
Apply a function on many item in a concurrent way
krankForConcurrently :: [a] -> (a -> m b) -> m [b] Source #
krankReadFile :: FilePath -> m ByteString Source #
Read a file from filesystem
krankPutStrLnStderr :: Text -> m () Source #
Log an error (with trailing n)
krankPutStr :: Text -> m () Source #
Log a message (without trailing n)
Instances
| MonadKrank Krank Source # | The real monad implementation for Krank |
Defined in Krank Methods krankRunRESTRequest :: FromJSON t => Url Https -> Option Https -> Krank t Source # krankAsks :: (KrankConfig -> b) -> Krank b Source # krankMapConcurrently :: (a -> Krank b) -> [a] -> Krank [b] Source # krankForConcurrently :: [a] -> (a -> Krank b) -> Krank [b] Source # krankReadFile :: FilePath -> Krank ByteString Source # krankPutStrLnStderr :: Text -> Krank () Source # krankPutStr :: Text -> Krank () Source # | |