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


-- | Compression and decompression in the exomizer format
--   
--   This package provides a pure interface for compressing and
--   decompressing data represented as strict <tt>ByteStrings</tt>.
--   
--   Only the <tt>raw</tt>, <tt>mem</tt> and <tt>level</tt> compressions
--   are supported.
--   
--   This library uses the <tt>exomizer 2.0.10</tt>.
--   
--   <tt>exomizer</tt> is created by Magnus Lind (magli143@gmail.com)
--   <a>https://bitbucket.org/magli143/exomizer/wiki/Home</a>
@package exomizer
@version 1.0.0


-- | Cruncher interface <tt>exomizer mem</tt> style.
module Exomizer.Mem

-- | Parameters for compression
data CrunchOptions

coEncoding :: CrunchOptions -> Maybe String

coMaxPasses :: CrunchOptions -> Int

coMaxLen :: CrunchOptions -> Int

coMaxOffset :: CrunchOptions -> Int

coUseLiteralSequences :: CrunchOptions -> Bool

coFavourSpeed :: CrunchOptions -> Bool

-- | Default compression parameters
defaultCrunchOptions :: CrunchOptions

-- | Check if the options are valid
validCrunchOptions :: CrunchOptions -> Bool

-- | Information about the compressed data (result of the compression)
data CrunchInfo

ciLiteralSequencesUsed :: CrunchInfo -> Bool

ciNeededSafetyOffset :: CrunchInfo -> Int

ciUsedEncoding :: CrunchInfo -> String

-- | Direction
data Direction

-- | Starting at the lowest and ending the byte after the highest
Forward :: Direction

-- | Starting one byte after the highest and ending on the lowest
Backwards :: Direction

-- | Direction of reading (the compressed data) and writing (the
--   uncompressed data)
--   
--   <pre>
--   readDirection `ReadWrite` writeDirection
--   </pre>
data ReadWrite
ReadWrite :: Direction -> Direction -> ReadWrite

-- | Forward: both read and write
forward :: ReadWrite

-- | Backwards: both read and write
backwards :: ReadWrite

-- | Crunch data <tt>exomizer mem</tt> style. This function does not have
--   automatic joining of multiple chunks, see <a>joinChunks</a>.
memCrunch :: ReadWrite -> CrunchOptions -> (Int16, ByteString) -> (ByteString, CrunchInfo)

-- | Identical to <a>memCrunch</a> but does not return the
--   <a>CrunchInfo</a>.
memCrunch_ :: ReadWrite -> CrunchOptions -> (Int16, ByteString) -> ByteString

-- | Join the supplied chunks into one. The spaces in between are filled
--   with the supplied byte.
--   
--   There is no check for overlap or if the result exceeds the memory
--   space.
joinChunks :: Word8 -> [(Int16, ByteString)] -> (Int16, ByteString)


-- | Cruncher interface <tt>exomizer raw</tt> style.
module Exomizer.Raw

-- | Parameters for compression
data CrunchOptions

coEncoding :: CrunchOptions -> Maybe String

coMaxPasses :: CrunchOptions -> Int

coMaxLen :: CrunchOptions -> Int

coMaxOffset :: CrunchOptions -> Int

coUseLiteralSequences :: CrunchOptions -> Bool

coFavourSpeed :: CrunchOptions -> Bool

-- | Default compression parameters
defaultCrunchOptions :: CrunchOptions

-- | Check if the options are valid
validCrunchOptions :: CrunchOptions -> Bool

-- | Information about the compressed data (result of the compression)
data CrunchInfo

ciLiteralSequencesUsed :: CrunchInfo -> Bool

ciNeededSafetyOffset :: CrunchInfo -> Int

ciUsedEncoding :: CrunchInfo -> String

-- | Direction
data Direction

-- | Starting at the lowest and ending the byte after the highest
Forward :: Direction

-- | Starting one byte after the highest and ending on the lowest
Backwards :: Direction

-- | Direction of reading (the compressed data) and writing (the
--   uncompressed data)
--   
--   <pre>
--   readDirection `ReadWrite` writeDirection
--   </pre>
data ReadWrite
ReadWrite :: Direction -> Direction -> ReadWrite

-- | Forward: both read and write
forward :: ReadWrite

-- | Backwards: both read and write
backwards :: ReadWrite

-- | Crunch data <tt>exomizer raw</tt> style.
rawCrunch :: ReadWrite -> CrunchOptions -> ByteString -> (ByteString, CrunchInfo)

-- | Identical to <a>rawCrunch</a> but does not return the
--   <a>CrunchInfo</a>.
rawCrunch_ :: ReadWrite -> CrunchOptions -> ByteString -> ByteString

-- | Decrunch some data.
--   
--   WARNING: The linked exomizer library (and with that the program) may
--   segfault when the input data is not valid!
rawDecrunch :: ReadWrite -> ByteString -> ByteString


-- | The functions of this module are identical to use the command line
--   tool.
--   
--   The modules <a>Exomizer.Raw</a> and <a>Exomizer.Mem</a> give more
--   options.
--   
--   Each function is listed with and without an underscore at the end. The
--   variant with the underscore does not return the compression info but
--   the compression result is identical.
module Exomizer

-- | Parameters for compression
data CrunchOptions

coEncoding :: CrunchOptions -> Maybe String

coMaxPasses :: CrunchOptions -> Int

coMaxLen :: CrunchOptions -> Int

coMaxOffset :: CrunchOptions -> Int

coUseLiteralSequences :: CrunchOptions -> Bool

coFavourSpeed :: CrunchOptions -> Bool

-- | Default compression parameters
defaultCrunchOptions :: CrunchOptions

-- | Information about the compressed data (result of the compression)
data CrunchInfo

ciLiteralSequencesUsed :: CrunchInfo -> Bool

ciNeededSafetyOffset :: CrunchInfo -> Int

ciUsedEncoding :: CrunchInfo -> String

-- | Same as <tt>exomizer raw</tt>
exomizerRaw :: CrunchOptions -> ByteString -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer raw</tt>
exomizerRaw_ :: CrunchOptions -> ByteString -> ByteString

-- | Same as <tt>exomizer raw -b</tt>
exomizerRawBackwards :: CrunchOptions -> ByteString -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer raw -b</tt>
exomizerRawBackwards_ :: CrunchOptions -> ByteString -> ByteString

-- | Same as <tt>exomizer raw -r</tt>
exomizerRawReverse :: CrunchOptions -> ByteString -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer raw -r</tt>
exomizerRawReverse_ :: CrunchOptions -> ByteString -> ByteString

-- | Same as <tt>exomizer raw -b -r</tt>
exomizerRawBackwardsReverse :: CrunchOptions -> ByteString -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer raw -b -r</tt>
exomizerRawBackwardsReverse_ :: CrunchOptions -> ByteString -> ByteString

-- | Same as <tt>exomizer mem -l none</tt>
exomizerMem :: CrunchOptions -> [(Int16, ByteString)] -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer mem -l none</tt>
exomizerMem_ :: CrunchOptions -> [(Int16, ByteString)] -> ByteString

-- | Same as <tt>exomizer mem -l none -f</tt>
exomizerMemForward :: CrunchOptions -> [(Int16, ByteString)] -> (ByteString, CrunchInfo)

-- | Same as <tt>exomizer mem -l none -f</tt>
exomizerMemForward_ :: CrunchOptions -> [(Int16, ByteString)] -> ByteString

-- | Same as <tt>exomizer level</tt>
exomizerLevel_ :: CrunchOptions -> [(Int16, ByteString)] -> ByteString

-- | Same as <tt>exomizer level -f</tt>
exomizerLevelForward_ :: CrunchOptions -> [(Int16, ByteString)] -> ByteString