System.Log.FastLogger.Internal

The contents of this module can change at any time without warning.

Documentation

type Buffer = Ptr Word8

type BufSize = Int

The type for buffer size of each core.

defaultBufSize :: BufSize

The default buffer size (4,096 bytes).

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

invalidFD :: FD

isFDValid :: FD -> Bool

data Builder

Builders denote sequences of bytes. They are Monoids where mempty is the zero-length sequence and mappend is concatenation, which runs in O(1).

Instances

Monoid Builder

Defined in Data.ByteString.Builder.Internal

Methods

mempty :: Builder

mappend :: Builder -> Builder -> Builder

mconcat :: [Builder] -> Builder

Semigroup Builder

Defined in Data.ByteString.Builder.Internal

Methods

(<>) :: Builder -> Builder -> Builder

sconcat :: NonEmpty Builder -> Builder

stimes :: Integral b => b -> Builder -> Builder

ToLogStr Builder

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Builder -> LogStr

data LogStr

Log message builder. Use (<>) to append two LogStr in O(1).

Constructors

LogStr !Int Builder

Instances

IsString LogStr

Defined in System.Log.FastLogger.LogStr

Methods

fromString :: String -> LogStr

Monoid LogStr

Defined in System.Log.FastLogger.LogStr

Methods

mempty :: LogStr

mappend :: LogStr -> LogStr -> LogStr

mconcat :: [LogStr] -> LogStr

Semigroup LogStr

Defined in System.Log.FastLogger.LogStr

Methods

(<>) :: LogStr -> LogStr -> LogStr

sconcat :: NonEmpty LogStr -> LogStr

stimes :: Integral b => b -> LogStr -> LogStr

Show LogStr

Defined in System.Log.FastLogger.LogStr

Methods

showsPrec :: Int -> LogStr -> ShowS

show :: LogStr -> String

showList :: [LogStr] -> ShowS

ToLogStr LogStr

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: LogStr -> LogStr

Eq LogStr

Defined in System.Log.FastLogger.LogStr

Methods

(==) :: LogStr -> LogStr -> Bool

(/=) :: LogStr -> LogStr -> Bool

logStrLength :: LogStr -> Int

Obtaining the length of LogStr.

fromLogStr :: LogStr -> ByteString

Converting LogStr to ByteString.

class ToLogStr msg where

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.

Methods

toLogStr :: msg -> LogStr

Instances

ToLogStr Int16

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Int16 -> LogStr

ToLogStr Int32

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Int32 -> LogStr

ToLogStr Int64

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Int64 -> LogStr

ToLogStr Int8

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Int8 -> LogStr

ToLogStr Word16

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Word16 -> LogStr

ToLogStr Word32

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Word32 -> LogStr

ToLogStr Word64

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Word64 -> LogStr

ToLogStr Word8

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Word8 -> LogStr

ToLogStr Builder

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Builder -> LogStr

ToLogStr ByteString

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: ByteString -> LogStr

ToLogStr ByteString

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: ByteString -> LogStr

ToLogStr ShortByteString

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: ShortByteString -> LogStr

ToLogStr LogStr

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: LogStr -> LogStr

ToLogStr Text

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Text -> LogStr

ToLogStr Text

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Text -> LogStr

ToLogStr String

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: String -> LogStr

ToLogStr Integer

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Integer -> LogStr

ToLogStr Double

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Double -> LogStr

ToLogStr Float

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Float -> LogStr

ToLogStr Int

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Int -> LogStr

ToLogStr Word

Since: 2.4.14

Defined in System.Log.FastLogger.LogStr

Methods

toLogStr :: Word -> LogStr

mempty :: Monoid a => a

Identity of mappend

>>> "Hello world" <> mempty
"Hello world"

(<>) :: Semigroup a => a -> a -> a infixr 6

An associative operation.

>>> [1,2,3] <> [4,5,6]
[1,2,3,4,5,6]

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.

writeLogStr :: Buffer -> IORef FD -> LogStr -> IO ()

Writting LogStr using a buffer in blocking mode. The size of LogStr must be smaller or equal to the size of buffer.

writeBigLogStr :: IORef FD -> LogStr -> IO ()

Writting LogStr using a temporary buffer.

class Loggers a where

A class for internal loggers.

Methods

stopLoggers :: a -> IO ()

pushLog :: a -> LogStr -> IO ()

flushAllLog :: a -> IO ()

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 ()

module System.Log.FastLogger.LoggerSet