| Portability | unknown |
|---|---|
| Stability | unstable |
| Maintainer | Conrad Parker <conrad@metadecks.org> |
Data.ZoomCache.Write
Description
Writing of ZoomCache files.
- class ZoomWrite t where
- writeData :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> a -> ZoomW ()
- writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (SampleOffset, a) -> ZoomW ()
- writeDataTS :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()
- type ZoomW = StateT ZoomWHandle IO
- withFileWrite :: TrackMap -> Maybe UTCTime -> Bool -> ZoomW () -> FilePath -> IO ()
- flush :: ZoomW ()
- data ZoomWHandle
- openWrite :: TrackMap -> Maybe UTCTime -> Bool -> FilePath -> IO ZoomWHandle
- closeWrite :: ZoomWHandle -> IO ()
- watermark :: TrackNo -> ZoomW (Maybe Int)
- setWatermark :: TrackNo -> Int -> ZoomW ()
The ZoomWrite class
The ZoomWrite class provides write, a method to write a
Haskell value to an open ZoomCache file.
Instances
Instance helpers
writeDataVBR :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (SampleOffset, a) -> ZoomW ()Source
writeDataTS :: (Typeable a, ZoomWrite a, ZoomWritable a) => TrackNo -> (TimeStamp, a) -> ZoomW ()Source
The ZoomW monad
type ZoomW = StateT ZoomWHandle IOSource
A StateT IO monad for writing a ZoomCache file
Arguments
| :: TrackMap | |
| -> Maybe UTCTime | |
| -> Bool | Whether or not to write raw data packets. If False, only summary blocks are written. |
| -> ZoomW () | |
| -> FilePath | |
| -> IO () |
Run a ZoomW () action on a given file handle, using the specified
TrackMap specification
Force a flush of ZoomCache summary blocks to disk. It is not usually necessary to call this function as summary blocks are transparently written at regular intervals.
ZoomWHandle IO functions
data ZoomWHandle Source
Arguments
| :: TrackMap | |
| -> Maybe UTCTime | |
| -> Bool | Whether or not to write raw data packets. If False, only summary blocks are written. |
| -> FilePath | |
| -> IO ZoomWHandle |
Open a new ZoomCache file for writing, using a specified TrackMap.
closeWrite :: ZoomWHandle -> IO ()Source