Exomizer.Mem

Cruncher interface exomizer mem style.

Options & Info

data CrunchOptions

Parameters for compression

Since: 1.0.0

Instances

Eq CrunchOptions

Methods

(==) :: CrunchOptions -> CrunchOptions -> Bool

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

Show CrunchOptions

Methods

showsPrec :: Int -> CrunchOptions -> ShowS

show :: CrunchOptions -> String

showList :: [CrunchOptions] -> ShowS

coEncoding :: CrunchOptions -> Maybe String

Since: 1.0.0

coMaxPasses :: CrunchOptions -> Int

Since: 1.0.0

coMaxLen :: CrunchOptions -> Int

Since: 1.0.0

coMaxOffset :: CrunchOptions -> Int

Since: 1.0.0

coUseLiteralSequences :: CrunchOptions -> Bool

Since: 1.0.0

coFavourSpeed :: CrunchOptions -> Bool

Since: 1.0.0

defaultCrunchOptions :: CrunchOptions

Default compression parameters

Since: 1.0.0

validCrunchOptions :: CrunchOptions -> Bool

Check if the options are valid

Since: 1.0.0

data CrunchInfo

Information about the compressed data (result of the compression)

Since: 1.0.0

Instances

Eq CrunchInfo

Methods

(==) :: CrunchInfo -> CrunchInfo -> Bool

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

Show CrunchInfo

Methods

showsPrec :: Int -> CrunchInfo -> ShowS

show :: CrunchInfo -> String

showList :: [CrunchInfo] -> ShowS

ciLiteralSequencesUsed :: CrunchInfo -> Bool

Since: 1.0.0

ciNeededSafetyOffset :: CrunchInfo -> Int

Since: 1.0.0

ciUsedEncoding :: CrunchInfo -> String

Since: 1.0.0

Direction

data Direction

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

Methods

(==) :: Direction -> Direction -> Bool

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

data ReadWrite

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

readDirection `ReadWrite` writeDirection

Since: 1.0.0

Constructors

Direction `ReadWrite` Direction

forward :: ReadWrite

Forward: both read and write

Since: 1.0.0

backwards :: ReadWrite

Backwards: both read and write

Since: 1.0.0

Mem crunchers

memCrunch :: ReadWrite -> CrunchOptions -> (Int16, ByteString) -> (ByteString, CrunchInfo)

Crunch data exomizer mem style. This function does not have automatic joining of multiple chunks, see joinChunks.

Since: 1.0.0

memCrunch_ :: ReadWrite -> CrunchOptions -> (Int16, ByteString) -> ByteString

Identical to memCrunch but does not return the CrunchInfo.

Since: 1.0.0

Join chunks

joinChunks :: Word8 -> [(Int16, ByteString)] -> (Int16, 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.

Since: 1.0.0