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


-- | Flexible byte dump helpers for human readers.
--   
--   A set of helpers to dump bytes with lots of different output formats
--   easy to read for humans eyes.
@package bytedump
@version 1.0


-- | A module containing some routines to debug data dump
module Text.Bytedump

-- | Dump one byte into a 2 hexadecimal characters.
hexString :: Word8 -> String

-- | Configuration structure used for formatting functions
data BytedumpConfig
BytedumpConfig :: Int -> Int -> String -> String -> String -> String -> Bool -> BytedumpConfig

-- | number of bytes per row.
[configRowSize] :: BytedumpConfig -> Int

-- | number of bytes per group per row.
[configRowGroupSize] :: BytedumpConfig -> Int

-- | string separating groups.
[configRowGroupSep] :: BytedumpConfig -> String

-- | string on the left of the row.
[configRowLeft] :: BytedumpConfig -> String

-- | string on the right of the row.
[configRowRight] :: BytedumpConfig -> String

-- | string separating cells in row.
[configCellSep] :: BytedumpConfig -> String

-- | if the printable ascii table is displayed.
[configPrintChar] :: BytedumpConfig -> Bool

-- | Default Config using 16 bytes by row with a separation at the 8th
--   byte, and dumping printable ascii character on the right.
defaultConfig :: BytedumpConfig

-- | Dump a list of word8 into a raw string of hex value
dumpRaw :: [Word8] -> String

-- | Dump a string into a raw string of hex value
dumpRawS :: String -> String

-- | Dump a bytestring into a raw string of hex value
dumpRawBS :: ByteString -> String

-- | Dump a lazy bytestring into a raw string of hex value
dumpRawLBS :: ByteString -> String

-- | Dump a list of bytes into formatted strings using a specific config
dumpWith :: BytedumpConfig -> [Word8] -> String

-- | Dump a string into formatted strings using a specific config
dumpWithS :: BytedumpConfig -> String -> String

-- | Dump a bytestring into formatted strings using a specific config
dumpWithBS :: BytedumpConfig -> ByteString -> String

-- | Dump a lazy bytestring into formatted strings using a specific config
dumpWithLBS :: BytedumpConfig -> ByteString -> String

-- | Dump a list of word8 into a formatted string of hex value
dump :: [Word8] -> String

-- | Dump a string into a formatted string of hex value
dumpS :: String -> String

-- | Dump a bytestring into a formatted string of hex value
dumpBS :: ByteString -> String

-- | Dump a lazy bytestring into a formatted string of hex value
dumpLBS :: ByteString -> String

-- | Dump two list of word8 into a formatted string of hex value side by
--   side
dumpDiff :: [Word8] -> [Word8] -> String

-- | Dump a string into a formatted string of hex value
dumpDiffS :: String -> String -> String

-- | Dump a bytestring into a formatted string of hex value
dumpDiffBS :: ByteString -> ByteString -> String

-- | Dump a lazy bytestring into a formatted string of hex value
dumpDiffLBS :: ByteString -> ByteString -> String
instance GHC.Classes.Eq Text.Bytedump.BytedumpConfig
instance GHC.Internal.Show.Show Text.Bytedump.BytedumpConfig
