-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Multicast, thread-safe, and fast logger.
--   
--   Please see the README on GitHub at
--   <a>https://github.com/kirisaki/caster#readme</a>
@package caster
@version 0.0.2.0


module System.Log.Caster

-- | Log message.
data LogMsg
LogMsg :: LogLevel -> UnixTime -> Builder -> LogMsg
[logMsgLevel] :: LogMsg -> LogLevel
[logMsgTime] :: LogMsg -> UnixTime
[logMsgBuilder] :: LogMsg -> Builder

-- | Connect <tt>LogQueue</tt> and <tt>TChan</tt> <tt>LogMsg</tt>.
broadcastLog :: LogQueue -> LogChan -> IO ()

-- | Queue of <tt>LogMsg</tt>.
newtype LogQueue
LogQueue :: TQueue LogMsg -> LogQueue

-- | Make new <tt>LogQueue</tt>
newLogQueue :: IO LogQueue

-- | Channel of <tt>LogMsg</tt>.
newtype LogChan
LogChan :: TChan LogMsg -> LogChan

-- | Make new <tt>LogChan</tt>.
newLogChan :: IO LogChan

-- | Formatter.
type Formatter = LogMsg -> Builder

-- | IO function takes <tt>LogMsg</tt>.
type Listener = LogMsg -> IO ()

-- | Listen <tt>LogChan</tt> and give the <tt>LogMsg</tt> to given
--   <tt>Listener</tt>.
relayLog :: LogChan -> LogLevel -> Listener -> IO ()

-- | Stdout listener.
stdoutListener :: Listener

-- | Stdout listener with <tt>Formatter</tt>.
stdoutListenerWith :: Formatter -> Listener

-- | Terminal listener. Log levels are colored.
terminalListener :: Listener

-- | Make <tt>Listener</tt> from <tt>Handle</tt>
handleListener :: Formatter -> Handle -> Listener

-- | Make <tt>Listener</tt> flushing buffer after getting <tt>LogMsg</tt>
handleListenerFlush :: Formatter -> Handle -> Listener

-- | Default log formatter.
defaultFormatter :: Formatter

-- | Formatter for term. It provides colored logs.
terminalFormatter :: Formatter

-- | Log levels. These are matched to syslog.
data LogLevel
LogDebug :: LogLevel
LogInfo :: LogLevel
LogNotice :: LogLevel
LogWarn :: LogLevel
LogError :: LogLevel
LogCritical :: LogLevel
LogAlert :: LogLevel
LogEmergency :: LogLevel

-- | Push a message to <tt>LogQueue</tt>.
logAs :: (MonadIO m, ToBuilder s) => LogQueue -> LogLevel -> s -> m ()
debug :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
info :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
notice :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
warn :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
err :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
critical :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
alert :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()
emergency :: (MonadIO m, ToBuilder s) => LogQueue -> s -> m ()

-- | Types which are able to be converted into <tt><a>Builder</a>
--   Builder</tt> <tt>toBuilde</tt> encodes <tt>String</tt> and
--   <tt>Text</tt> as utf-8.
class ToBuilder a
toBuilder :: ToBuilder a => a -> Builder

-- | If you turn <tt>OverloadedStrings</tt> extension on, GHC can't deduce
--   the type of string literal. This function fix the type to
--   <tt><a>Builder</a> Builder</tt> without type annotation.
fix :: Builder -> Builder

-- | Infix version of <tt>fix</tt>.
($:) :: ToBuilder b => (Builder -> b) -> Builder -> b
infixr 0 $:

-- | Concat <tt>ToBuilder</tt> strings as <tt><a>Builder</a> Builder</tt>.
(<:>) :: (ToBuilder a, ToBuilder b) => a -> b -> Builder
infixr 6 <:>
instance GHC.Classes.Ord System.Log.Caster.LogLevel
instance GHC.Classes.Eq System.Log.Caster.LogLevel
instance GHC.Show.Show System.Log.Caster.LogLevel
instance System.Log.Caster.ToBuilder Data.ByteString.FastBuilder.Internal.Builder
instance System.Log.Caster.ToBuilder GHC.Base.String
instance System.Log.Caster.ToBuilder Data.Text.Internal.Text
instance System.Log.Caster.ToBuilder Data.Text.Internal.Lazy.Text
instance System.Log.Caster.ToBuilder Data.ByteString.Internal.ByteString
instance System.Log.Caster.ToBuilder Data.ByteString.Lazy.Internal.ByteString
instance System.Log.Caster.ToBuilder Data.ByteString.Builder.Internal.Builder
instance GHC.Show.Show a => System.Log.Caster.ToBuilder a