Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
System.Log.FastLogger.Internal
Description
The contents of this module can change at any time without warning.
Synopsis
- type Buffer = Ptr Word8
- type BufSize = Int
- defaultBufSize :: BufSize
- getBuffer :: BufSize -> IO Buffer
- freeBuffer :: Buffer -> IO ()
- toBufIOWith :: Buffer -> BufSize -> (Buffer -> Int -> IO ()) -> Builder -> IO ()
- type FD = FD
- closeFD :: FD -> IO ()
- openFileFD :: FilePath -> IO FD
- getStderrFD :: IO FD
- getStdoutFD :: IO FD
- writeRawBufferPtr2FD :: IORef FD -> Ptr Word8 -> Int -> IO Int
- isFDValid :: FD -> Bool
- invalidFD :: FD
- (<>) :: Semigroup a => a -> a -> a
- mempty :: Monoid a => a
- data Builder
- data LogStr = LogStr !Int Builder
- class ToLogStr msg where
- fromLogStr :: LogStr -> ByteString
- logStrLength :: LogStr -> Int
- data SingleLogger
- newSingleLogger :: BufSize -> IORef FD -> IO SingleLogger
- data MultiLogger
- newMultiLogger :: Int -> BufSize -> IORef FD -> IO MultiLogger
- writeLogStr :: Buffer -> IORef FD -> LogStr -> IO ()
- writeBigLogStr :: IORef FD -> LogStr -> IO ()
- class Loggers a where
- stopLoggers :: a -> IO ()
- pushLog :: a -> LogStr -> IO ()
- flushAllLog :: a -> IO ()
- module System.Log.FastLogger.LoggerSet
Documentation
The default buffer size (4,096 bytes).
freeBuffer :: Buffer -> IO () #
openFileFD :: FilePath -> IO FD #
getStderrFD :: IO FD #
getStdoutFD :: IO FD #
(<>) :: Semigroup a => a -> a -> a infixr 6 #
An associative operation.
Examples
>>>
[1,2,3] <> [4,5,6]
[1,2,3,4,5,6]
>>>
Just [1, 2, 3] <> Just [4, 5, 6]
Just [1,2,3,4,5,6]
>>>
putStr "Hello, " <> putStrLn "World!"
Hello, World!
Identity of mappend
Examples
>>>
"Hello world" <> mempty
"Hello world"
>>>
mempty <> [1, 2, 3]
[1,2,3]
Builder
s denote sequences of bytes.
They are Monoid
s where
mempty
is the zero-length sequence and
mappend
is concatenation, which runs in O(1).
Log message builder. Use (<>
) to append two LogStr in O(1).
Types that can be converted to a LogStr
. Instances for
types from the text
library use a UTF-8 encoding. Instances
for numerical types use a decimal encoding.
Instances
fromLogStr :: LogStr -> ByteString #
Converting LogStr
to ByteString
.
logStrLength :: LogStr -> Int #
Obtaining the length of LogStr
.
data SingleLogger #
A non-scale but time-ordered logger.
Instances
Loggers SingleLogger # | |
Defined in System.Log.FastLogger.SingleLogger Methods stopLoggers :: SingleLogger -> IO () # pushLog :: SingleLogger -> LogStr -> IO () # flushAllLog :: SingleLogger -> IO () # |
newSingleLogger :: BufSize -> IORef FD -> IO SingleLogger #
Creating SingleLogger
.
data MultiLogger #
A scale but non-time-ordered logger.
Instances
Loggers MultiLogger # | |
Defined in System.Log.FastLogger.MultiLogger Methods stopLoggers :: MultiLogger -> IO () # pushLog :: MultiLogger -> LogStr -> IO () # flushAllLog :: MultiLogger -> IO () # |
newMultiLogger :: Int -> BufSize -> IORef FD -> IO MultiLogger #
Creating MultiLogger
.
The first argument is the number of the internal builders.
A class for internal loggers.
Instances
Loggers MultiLogger # | |
Defined in System.Log.FastLogger.MultiLogger Methods stopLoggers :: MultiLogger -> IO () # pushLog :: MultiLogger -> LogStr -> IO () # flushAllLog :: MultiLogger -> IO () # | |
Loggers SingleLogger # | |
Defined in System.Log.FastLogger.SingleLogger Methods stopLoggers :: SingleLogger -> IO () # pushLog :: SingleLogger -> LogStr -> IO () # flushAllLog :: SingleLogger -> IO () # |