Codec.hs

{-# OPTIONS -Wall #-}
----------------------------------------------------------------------
-- |
-- Module      : Data.ZoomCache.Codec
-- Copyright   : Conrad Parker
-- License     : BSD3-style (see LICENSE)
--
-- Maintainer  : Conrad Parker <conrad@metadecks.org>
-- Stability   : unstable
-- Portability : unknown
--
-- 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".
----------------------------------------------------------------------

module Data.ZoomCache.Codec (
    -- * Interfaces
      ZoomReadable(..)
    , RawData()
    , SummaryData()
    , ZoomWritable(..)
    , ZoomWrite(..)

    -- * ZoomCache Types
    , TimeStamp(..)

    -- * Raw data iteratees
    , zReadInt16
    , zReadInt32
    , zReadInt64
    , zReadFloat64be
    , readRational64

    -- * Binary data helpers
    , fromRational64
    , fromIntegral32be
    , fromDouble

    -- * Write instance helpers
    , writeData
    , writeDataVBR
) where

import Blaze.ByteString.Builder.ZoomCache
import Data.Iteratee.ZoomCache.Utils
import Data.ZoomCache.Common
import Data.ZoomCache.Types
import Data.ZoomCache.Write