Data.ZoomCache.Codec

Interface for implementing ZoomCache codec instances. This module re-exports the interfaces required for developing zoom-cache codecs.

For sample implementations, read the source of the provided instances Data.ZoomCache.Int and Data.ZoomCache.Double.

Interfaces

class ZoomReadable a where

Associated Types

data RawData a :: *

data SummaryData a :: *

Methods

readRaw :: (Functor m, MonadIO m) => Iteratee [Word8] m a

fromList :: [a] -> RawData a

readSummary :: (Functor m, MonadIO m) => Iteratee [Word8] m (SummaryData a)

prettyRawData :: RawData a -> [String]

prettySummaryData :: SummaryData a -> String

Instances

ZoomReadable Double

ZoomReadable Int

class ZoomWritable a where

Associated Types

data SummaryWork a :: *

Methods

fromRaw :: a -> Builder

fromSummaryData :: SummaryData a -> Builder

initSummaryWork :: TimeStamp -> SummaryWork a

toSummaryData :: Double -> SummaryWork a -> SummaryData a

updateSummaryData :: Int -> TimeStamp -> a -> SummaryWork a -> SummaryWork a

appendSummaryData :: Double -> SummaryData a -> Double -> SummaryData a -> SummaryData a

Instances

ZoomWritable Double

ZoomWritable Int

class ZoomWrite t where

The ZoomWrite class provides write, a method to write a Haskell value to an open ZoomCache file.

Methods

write :: TrackNo -> t -> ZoomW ()

Write a value to an open ZoomCache file.

Instances

ZoomWrite Double

ZoomWrite Int

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Int)

ZoomCache Types

data TimeStamp

Constructors

TS

Fields

unTS :: !Integer

Instances

Eq TimeStamp

Ord TimeStamp

Show TimeStamp

ZoomWrite (TimeStamp, Double)

ZoomWrite (TimeStamp, Int)

Raw data iteratees

zReadInt16 :: (Functor m, MonadIO m) => Iteratee [Word8] m Int

zReadInt32 :: (Functor m, MonadIO m) => Iteratee [Word8] m Int

zReadInt64 :: (Functor m, MonadIO m) => Iteratee [Word8] m Integer

zReadFloat64be :: (Functor m, MonadIO m) => Iteratee [Word8] m Double

readRational64 :: (Functor m, MonadIO m) => Iteratee [Word8] m Rational

Binary data helpers

fromRational64 :: Rational -> Builder

Serialize a Rational as a sequence of two 64bit big endian format integers.

fromIntegral32be :: forall a. Integral a => a -> Builder

Serialize an Integral in 32bit big endian format.

fromDouble :: Double -> Builder

Serialize a Double in big-endian IEEE 754-2008 binary64 format (IEEE 754-1985 double format).

Write instance helpers

writeData :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> a -> ZoomW ()

writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()