Safe Haskell	None
Language	Haskell2010

Exomizer.Raw

Contents

Options & Info
Direction
Raw crunchers

Description

Cruncher interface exomizer raw style.

Synopsis

Options & Info

data CrunchOptions Source #

Parameters for compression

Since: 1.0.0

Instances

Eq CrunchOptions Source #
Methods (==) :: CrunchOptions -> CrunchOptions -> Bool # (/=) :: CrunchOptions -> CrunchOptions -> Bool #
Show CrunchOptions Source #
Methods showsPrec :: Int -> CrunchOptions -> ShowS # show :: CrunchOptions -> String # showList :: [CrunchOptions] -> ShowS #

coEncoding :: CrunchOptions -> Maybe String Source #

Since: 1.0.0

coMaxPasses :: CrunchOptions -> Int Source #

Since: 1.0.0

coMaxLen :: CrunchOptions -> Int Source #

Since: 1.0.0

coMaxOffset :: CrunchOptions -> Int Source #

Since: 1.0.0

coUseLiteralSequences :: CrunchOptions -> Bool Source #

Since: 1.0.0

coFavourSpeed :: CrunchOptions -> Bool Source #

Since: 1.0.0

defaultCrunchOptions :: CrunchOptions Source #

Default compression parameters

Since: 1.0.0

validCrunchOptions :: CrunchOptions -> Bool Source #

Check if the options are valid

Since: 1.0.0

data CrunchInfo Source #

Information about the compressed data (result of the compression)

Since: 1.0.0

Instances

Eq CrunchInfo Source #
Methods (==) :: CrunchInfo -> CrunchInfo -> Bool # (/=) :: CrunchInfo -> CrunchInfo -> Bool #
Show CrunchInfo Source #
Methods showsPrec :: Int -> CrunchInfo -> ShowS # show :: CrunchInfo -> String # showList :: [CrunchInfo] -> ShowS #

ciLiteralSequencesUsed :: CrunchInfo -> Bool Source #

Since: 1.0.0

ciNeededSafetyOffset :: CrunchInfo -> Int Source #

Since: 1.0.0

ciUsedEncoding :: CrunchInfo -> String Source #

Since: 1.0.0

Direction

data Direction Source #

Direction

Since: 1.0.0

Constructors

Forward	Starting at the lowest and ending the byte after the highest
Backwards	Starting one byte after the highest and ending on the lowest

Instances

Eq Direction Source #
Methods (==) :: Direction -> Direction -> Bool # (/=) :: Direction -> Direction -> Bool #

data ReadWrite Source #

Direction of reading (the compressed data) and writing (the uncompressed data)

readDirection `ReadWrite` writeDirection

Since: 1.0.0

Constructors

Direction `ReadWrite` Direction

forward :: ReadWrite Source #

Forward: both read and write

Since: 1.0.0

backwards :: ReadWrite Source #

Backwards: both read and write

Since: 1.0.0

Raw crunchers

rawCrunch :: ReadWrite -> CrunchOptions -> ByteString -> (ByteString, CrunchInfo) Source #

Crunch data exomizer raw style.

Since: 1.0.0

rawCrunch_ :: ReadWrite -> CrunchOptions -> ByteString -> ByteString Source #

Identical to rawCrunch but does not return the CrunchInfo.

Since: 1.0.0

rawDecrunch :: ReadWrite -> ByteString -> ByteString Source #

Decrunch some data.

WARNING: The linked exomizer library (and with that the program) may segfault when the input data is not valid!

Since: 1.0.0