Safe Haskell	Safe-Inferred

Util.Serialize

Contents

magic
util
versions

Description

This module implements a Serialize class and serializers for basic types.

It duplicates a lot from the standard Serialize class, but this one at least is under my control. The other one is not guaranteed to remain compatible. Of course, it's unlikely to change incompatibly and I use it myself rather than re-implementing String and Integer encoding, but that's the theory anyway.

At the least it lets me use a direct float encoding rather than hacking around the large and buggy default implementation.

Synopsis

encode :: Serialize a => a -> ByteString.ByteString
decode :: Serialize a => ByteString.ByteString -> Either String a
class Serialize a where
- put :: Putter a
- get :: Get a
data Get a
type Put = PutM ()
data Magic a = Magic !Char !Char !Char !Char
magicBytes :: Magic a -> ByteString.ByteString
serialize :: Serialize a => Magic a -> FilePath -> a -> IO Bool
serialize_rotate :: Serialize a => Int.Int -> Magic a -> FilePath -> a -> IO Bool
data UnserializeError
- = BadMagic ByteString.ByteString ByteString.ByteString
- | IOError IO.Error.IOError
- | UnserializeError String
unserialize :: Serialize a => Magic a -> FilePath -> IO (Either UnserializeError a)
get_tag :: Get Word.Word8
put_tag :: Word.Word8 -> Put
bad_tag :: String -> Word.Word8 -> Get a
get_enum :: Get Word.Word8
put_enum :: Word.Word8 -> Put
bad_enum :: String -> Word.Word8 -> Get a
get_enum_unsafe :: (Bounded a, Enum a) => Get a
put_enum_unsafe :: Enum a => a -> Put
get_version :: Get Word.Word8
put_version :: Word.Word8 -> Put
bad_version :: CallStack.Stack => String -> Word.Word8 -> a

Documentation

encode :: Serialize a => a -> ByteString.ByteString Source #

decode :: Serialize a => ByteString.ByteString -> Either String a Source #

class Serialize a where Source #

Methods

put :: Putter a Source #

get :: Get a Source #

Instances

Instances details

Serialize Int.Int64 Source #
Instance details Defined in Util.Serialize Methods put :: Putter Int.Int64 Source # get :: Get Int.Int64 Source #
Serialize Word.Word32 Source #
Instance details Defined in Util.Serialize Methods put :: Putter Word.Word32 Source # get :: Get Word.Word32 Source #
Serialize Word.Word64 Source #
Instance details Defined in Util.Serialize Methods put :: Putter Word.Word64 Source # get :: Get Word.Word64 Source #
Serialize Word.Word8 Source #
Instance details Defined in Util.Serialize Methods put :: Putter Word.Word8 Source # get :: Get Word.Word8 Source #
Serialize ByteString.ByteString Source #
Instance details Defined in Util.Serialize Methods put :: Putter ByteString.ByteString Source # get :: Get ByteString.ByteString Source #
Serialize CmdResult Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter CmdResult Source # get :: Get CmdResult Source #
Serialize Editor Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter Editor Source # get :: Get Editor Source #
Serialize File Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter File Source # get :: Get File Source #
Serialize FileType Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter FileType Source # get :: Get FileType Source #
Serialize NotifySeq Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter NotifySeq Source # get :: Get NotifySeq Source #
Serialize Query Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter Query Source # get :: Get Query Source #
Serialize Response Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter Response Source # get :: Get Response Source #
Serialize Result Source #
Instance details Defined in App.ReplProtocol Methods put :: Putter Result Source # get :: Get Result Source #
Serialize Attributes Source #
Instance details Defined in Derive.Attrs Methods put :: Putter Attributes Source # get :: Get Attributes Source #
Serialize MiniVal Source #
Instance details Defined in Derive.Expr Methods put :: Putter MiniVal Source # get :: Get MiniVal Source #
Serialize Str Source #
Instance details Defined in Derive.Expr Methods put :: Putter Str Source # get :: Get Str Source #
Serialize Symbol Source #
Instance details Defined in Derive.Expr Methods put :: Putter Symbol Source # get :: Get Symbol Source #
Serialize Call Source #
Instance details Defined in Derive.REnv Methods put :: Putter Call Source # get :: Get Call Source #
Serialize Environ Source #
Instance details Defined in Derive.REnv Methods put :: Putter Environ Source # get :: Get Environ Source #
Serialize Term Source #
Instance details Defined in Derive.REnv Methods put :: Putter Term Source # get :: Get Term Source #
Serialize Val Source #
Instance details Defined in Derive.REnv Methods put :: Putter Val Source # get :: Get Val Source #
Serialize Control Source #
Instance details Defined in Derive.ScoreT Methods put :: Putter Control Source # get :: Get Control Source #
Serialize Instrument Source #
Instance details Defined in Derive.ScoreT Methods put :: Putter Instrument Source # get :: Get Instrument Source #
Serialize PControl Source #
Instance details Defined in Derive.ScoreT Methods put :: Putter PControl Source # get :: Get PControl Source #
Serialize Type Source #
Instance details Defined in Derive.ScoreT Methods put :: Putter Type Source # get :: Get Type Source #
Serialize Frame Source #
Instance details Defined in Derive.Stack Methods put :: Putter Frame Source # get :: Get Frame Source #
Serialize Stack Source #
Instance details Defined in Derive.Stack Methods put :: Putter Stack Source # get :: Get Stack Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #
Serialize Flag Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Flag Source # get :: Get Flag Source #
Serialize Qualified Source #
Instance details Defined in Instrument.InstT Methods put :: Putter Qualified Source # get :: Get Qualified Source #
Serialize Index Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter Index Source # get :: Get Index Source #
Serialize InstrumentDb Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter InstrumentDb Source # get :: Get InstrumentDb Source #
Serialize Key Source #
Instance details Defined in Midi.Midi Methods put :: Putter Key Source # get :: Get Key Source #
Serialize Message Source #
Instance details Defined in Midi.Instances Methods put :: Putter Message Source # get :: Get Message Source #
Serialize ReadDevice Source #
Instance details Defined in Midi.Midi Methods put :: Putter ReadDevice Source # get :: Get ReadDevice Source #
Serialize ReadMessage Source #
Instance details Defined in Midi.Instances Methods put :: Putter ReadMessage Source # get :: Get ReadMessage Source #
Serialize WriteDevice Source #
Instance details Defined in Midi.Midi Methods put :: Putter WriteDevice Source # get :: Get WriteDevice Source #
Serialize WriteMessage Source #
Instance details Defined in Midi.Instances Methods put :: Putter WriteMessage Source # get :: Get WriteMessage Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #
Serialize Duration Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Duration Source # get :: Get Duration Source #
Serialize StaffConfig Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter StaffConfig Source # get :: Get StaffConfig Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #
Serialize Flag Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Flag Source # get :: Get Flag Source #
Serialize Initialization Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Initialization Source # get :: Get Initialization Source #
Serialize InitializePatch Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter InitializePatch Source # get :: Get InitializePatch Source #
Serialize Keymap Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter Keymap Source # get :: Get Keymap Source #
Serialize Keyswitch Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter Keyswitch Source # get :: Get Keyswitch Source #
Serialize ModeMap Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter ModeMap Source # get :: Get ModeMap Source #
Serialize Patch Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter Patch Source # get :: Get Patch Source #
Serialize Scale Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Scale Source # get :: Get Scale Source #
Serialize Settings Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Settings Source # get :: Get Settings Source #
Serialize Degree Source #
Instance details Defined in Perform.Pitch Methods put :: Putter Degree Source # get :: Get Degree Source #
Serialize Key Source #
Instance details Defined in Perform.Pitch Methods put :: Putter Key Source # get :: Get Key Source #
Serialize Note Source #
Instance details Defined in Perform.Pitch Methods put :: Putter Note Source # get :: Get Note Source #
Serialize NoteNumber Source #
Instance details Defined in Perform.Pitch Methods put :: Putter NoteNumber Source # get :: Get NoteNumber Source #
Serialize Pitch Source #
Instance details Defined in Perform.Pitch Methods put :: Putter Pitch Source # get :: Get Pitch Source #
Serialize ScaleId Source #
Instance details Defined in Perform.Pitch Methods put :: Putter ScaleId Source # get :: Get ScaleId Source #
Serialize RealTime Source #
Instance details Defined in Perform.RealTime Methods put :: Putter RealTime Source # get :: Get RealTime Source #
Serialize State Source #
Instance details Defined in Synth.Faust.EffectC Methods put :: Putter State Source # get :: Get State Source #
Serialize PlayState Source #
Instance details Defined in Synth.Sampler.Render Methods put :: Putter PlayState Source # get :: Get PlayState Source #
Serialize ResampleState Source #
Instance details Defined in Synth.Sampler.Render Methods put :: Putter ResampleState Source # get :: Get ResampleState Source #
Serialize State Source #
Instance details Defined in Synth.Sampler.Render Methods put :: Putter State Source # get :: Get State Source #
Serialize Sample Source #
Instance details Defined in Synth.Sampler.Sample Methods put :: Putter Sample Source # get :: Get Sample Source #
Serialize Stretch Source #
Instance details Defined in Synth.Sampler.Sample Methods put :: Putter Stretch Source # get :: Get Stretch Source #
Serialize StretchMode Source #
Instance details Defined in Synth.Sampler.Sample Methods put :: Putter StretchMode Source # get :: Get StretchMode Source #
Serialize Control Source #
Instance details Defined in Synth.Shared.Control Methods put :: Putter Control Source # get :: Get Control Source #
Serialize Hash Source #
Instance details Defined in Synth.Shared.Note Methods put :: Putter Hash Source # get :: Get Hash Source #
Serialize Note Source #
Instance details Defined in Synth.Shared.Note Methods put :: Putter Note Source # get :: Get Note Source #
Serialize Block Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Block Source # get :: Get Block Source #
Serialize Divider Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Divider Source # get :: Get Divider Source #
Serialize NoteDestination Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter NoteDestination Source # get :: Get NoteDestination Source #
Serialize Padding Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Padding Source # get :: Get Padding Source #
Serialize Skeleton Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Skeleton Source # get :: Get Skeleton Source #
Serialize Track Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Track Source # get :: Get Track Source #
Serialize TrackDestinations Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter TrackDestinations Source # get :: Get TrackDestinations Source #
Serialize TrackFlag Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter TrackFlag Source # get :: Get TrackFlag Source #
Serialize TracklikeId Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter TracklikeId Source # get :: Get TracklikeId Source #
Serialize View Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter View Source # get :: Get View Source #
Serialize Color Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Color Source # get :: Get Color Source #
Serialize Event Source #
Instance details Defined in Ui.Event Methods put :: Putter Event Source # get :: Get Event Source #
Serialize Stack Source #
Instance details Defined in Ui.Event Methods put :: Putter Stack Source # get :: Get Stack Source #
Serialize Events Source #
Instance details Defined in Ui.Events Methods put :: Putter Events Source # get :: Get Events Source #
Serialize BlockId Source #
Instance details Defined in Ui.Id Methods put :: Putter BlockId Source # get :: Get BlockId Source #
Serialize Id Source #
Instance details Defined in Ui.Id Methods put :: Putter Id Source # get :: Get Id Source #
Serialize Namespace Source #
Instance details Defined in Ui.Id Methods put :: Putter Namespace Source # get :: Get Namespace Source #
Serialize RulerId Source #
Instance details Defined in Ui.Id Methods put :: Putter RulerId Source # get :: Get RulerId Source #
Serialize TrackId Source #
Instance details Defined in Ui.Id Methods put :: Putter TrackId Source # get :: Get TrackId Source #
Serialize ViewId Source #
Instance details Defined in Ui.Id Methods put :: Putter ViewId Source # get :: Get ViewId Source #
Serialize Mark Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Mark Source # get :: Get Mark Source #
Serialize Marklist Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Marklist Source # get :: Get Marklist Source #
Serialize AbstractMeter Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter AbstractMeter Source # get :: Get AbstractMeter Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #
Serialize LabelConfig Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter LabelConfig Source # get :: Get LabelConfig Source #
Serialize MSection Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter MSection Source # get :: Get MSection Source #
Serialize Meter Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Meter Source # get :: Get Meter Source #
Serialize Rank Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Rank Source # get :: Get Rank Source #
Serialize Ruler Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Ruler Source # get :: Get Ruler Source #
Serialize ScoreTime Source #
Instance details Defined in Ui.ScoreTime Methods put :: Putter ScoreTime Source # get :: Get ScoreTime Source #
Serialize Orientation Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Orientation Source # get :: Get Orientation Source #
Serialize Selection Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Selection Source # get :: Get Selection Source #
Serialize Skeleton Source #
Instance details Defined in Ui.Skeleton Methods put :: Putter Skeleton Source # get :: Get Skeleton Source #
Serialize StyleId Source #
Instance details Defined in Ui.Style Methods put :: Putter StyleId Source # get :: Get StyleId Source #
Serialize RenderConfig Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter RenderConfig Source # get :: Get RenderConfig Source #
Serialize RenderSource Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter RenderSource Source # get :: Get RenderSource Source #
Serialize RenderStyle Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter RenderStyle Source # get :: Get RenderStyle Source #
Serialize Track Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Track Source # get :: Get Track Source #
Serialize Orientation Source #
Instance details Defined in Ui.Types Methods put :: Putter Orientation Source # get :: Get Orientation Source #
Serialize State Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter State Source # get :: Get State Source #
Serialize Allocation Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Allocation Source # get :: Get Allocation Source #
Serialize Allocations Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Allocations Source # get :: Get Allocations Source #
Serialize Backend Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Backend Source # get :: Get Backend Source #
Serialize Config Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Config Source # get :: Get Config Source #
Serialize Default Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Default Source # get :: Get Default Source #
Serialize Meta Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Meta Source # get :: Get Meta Source #
Serialize Zoom Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Zoom Source # get :: Get Zoom Source #
Serialize Frames Source #
Instance details Defined in Util.Audio.AudioT Methods put :: Putter Frames Source # get :: Get Frames Source #
Serialize SavedState Source #
Instance details Defined in Util.Audio.Resample Methods put :: Putter SavedState Source # get :: Get SavedState Source #
Serialize CallStack.Caller Source #
Instance details Defined in Util.Serialize Methods put :: Putter CallStack.Caller Source # get :: Get CallStack.Caller Source #
Serialize Doc Source #
Instance details Defined in Util.Doc Methods put :: Putter Doc Source # get :: Get Doc Source #
Serialize Msg Source #
Instance details Defined in Util.Log Methods put :: Putter Msg Source # get :: Get Msg Source #
Serialize Priority Source #
Instance details Defined in Util.Log Methods put :: Putter Priority Source # get :: Get Priority Source #
Serialize Rect Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter Rect Source # get :: Get Rect Source #
Serialize UTCTime Source #
Instance details Defined in Util.Serialize Methods put :: Putter UTCTime Source # get :: Get UTCTime Source #
Serialize Text Source #
Instance details Defined in Util.Serialize Methods put :: Putter Text Source # get :: Get Text Source #
Serialize Integer Source #
Instance details Defined in Util.Serialize Methods put :: Putter Integer Source # get :: Get Integer Source #
Serialize () Source #
Instance details Defined in Util.Serialize Methods put :: Putter () Source # get :: Get () Source #
Serialize Bool Source #
Instance details Defined in Util.Serialize Methods put :: Putter Bool Source # get :: Get Bool Source #
Serialize Char Source #
Instance details Defined in Util.Serialize Methods put :: Putter Char Source # get :: Get Char Source #
Serialize Double Source #
Instance details Defined in Util.Serialize Methods put :: Putter Double Source # get :: Get Double Source #
Serialize Float Source #
Instance details Defined in Util.Serialize Methods put :: Putter Float Source # get :: Get Float Source #
Serialize Int.Int Source #
Instance details Defined in Util.Serialize Methods put :: Putter Int.Int Source # get :: Get Int.Int Source #
(Ord a, Serialize a) => Serialize (Set a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Set a) Source # get :: Get (Set a) Source #
Serialize a => Serialize (Typed a) Source #
Instance details Defined in Derive.ScoreT Methods put :: Putter (Typed a) Source # get :: Get (Typed a) Source #
Serialize a => Serialize (AttributeMap a) Source #
Instance details Defined in Instrument.Common Methods put :: Putter (AttributeMap a) Source # get :: Get (AttributeMap a) Source #
Serialize (Common ()) Source #
Instance details Defined in Instrument.Serialize Methods put :: Putter (Common ()) Source # get :: Get (Common ()) Source #
Serialize a => Serialize (Performance a) Source #
Instance details Defined in Cmd.Serialize Methods put :: Putter (Performance a) Source # get :: Get (Performance a) Source #
Serialize v => Serialize (Signal v) Source #
Instance details Defined in Util.Segment Methods put :: Putter (Signal v) Source # get :: Get (Signal v) Source #
Serialize y => Serialize (Sample y) Source #
Instance details Defined in Util.TimeVectorStorable Methods put :: Putter (Sample y) Source # get :: Get (Sample y) Source #
Serialize a => Serialize (Vector.Vector a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Vector.Vector a) Source # get :: Get (Vector.Vector a) Source #
(Serialize a, Storable a) => Serialize (Vector.Storable.Vector a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Vector.Storable.Vector a) Source # get :: Get (Vector.Storable.Vector a) Source #
(Serialize a, Unboxed.Unbox a) => Serialize (Unboxed.Vector a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Unboxed.Vector a) Source # get :: Get (Unboxed.Vector a) Source #
Serialize a => Serialize (NonEmpty a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (NonEmpty a) Source # get :: Get (NonEmpty a) Source #
Serialize a => Serialize (Maybe a) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Maybe a) Source # get :: Get (Maybe a) Source #
Serialize a => Serialize [a] Source #
Instance details Defined in Util.Serialize Methods put :: Putter [a] Source # get :: Get [a] Source #
(Serialize a, Serialize b) => Serialize (Either a b) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Either a b) Source # get :: Get (Either a b) Source #
(Serialize i, Ix i, Serialize e) => Serialize (Array i e) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Array i e) Source # get :: Get (Array i e) Source #
(Ord k, Serialize k, Serialize v) => Serialize (Map k v) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (Map k v) Source # get :: Get (Map k v) Source #
(Serialize control, Serialize val) => Serialize (Ref control val) Source #
Instance details Defined in Derive.DeriveT Methods put :: Putter (Ref control val) Source # get :: Get (Ref control val) Source #
Serialize (Signal kind) Source #
Instance details Defined in Perform.Signal Methods put :: Putter (Signal kind) Source # get :: Get (Signal kind) Source #
(Serialize a, Serialize b) => Serialize (a, b) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (a, b) Source # get :: Get (a, b) Source #
(Serialize a, Serialize b, Serialize c) => Serialize (a, b, c) Source #
Instance details Defined in Util.Serialize Methods put :: Putter (a, b, c) Source # get :: Get (a, b, c) Source #

data Get a #

The Get monad is an Exception and State monad.

Instances

Instances details

MonadFail Get
Instance details Defined in Data.Serialize.Get Methods fail :: String -> Get a #
Alternative Get
Instance details Defined in Data.Serialize.Get Methods empty :: Get a # (<\|>) :: Get a -> Get a -> Get a # some :: Get a -> Get [a] # many :: Get a -> Get [a] #
Applicative Get
Instance details Defined in Data.Serialize.Get Methods pure :: a -> Get a # (<>) :: Get (a -> b) -> Get a -> Get b # liftA2 :: (a -> b -> c) -> Get a -> Get b -> Get c # (>) :: Get a -> Get b -> Get b # (<*) :: Get a -> Get b -> Get a #
Functor Get
Instance details Defined in Data.Serialize.Get Methods fmap :: (a -> b) -> Get a -> Get b # (<$) :: a -> Get b -> Get a #
Monad Get
Instance details Defined in Data.Serialize.Get Methods (>>=) :: Get a -> (a -> Get b) -> Get b # (>>) :: Get a -> Get b -> Get b # return :: a -> Get a #
MonadPlus Get
Instance details Defined in Data.Serialize.Get Methods mzero :: Get a # mplus :: Get a -> Get a -> Get a #

type Put = PutM () #

Put merely lifts Builder into a Writer monad, applied to ().

magic

data Magic a Source #

This is a four byte prefix to identify a particular file type, tagged with the serialized type. The Chars are just for syntactic convenience only, and must be ASCII.

The constructor is not exported, so all magics have to be defined here, which should make it easy to avoid collisions.

Constructors

Magic !Char !Char !Char !Char

Instances

Instances details

Show (Magic a) Source #
Instance details Defined in Util.Serialize Methods showsPrec :: Int.Int -> Magic a -> ShowS # show :: Magic a -> String # showList :: [Magic a] -> ShowS #

magicBytes :: Magic a -> ByteString.ByteString Source #

serialize Source #

Arguments

:: Serialize a
=> Magic a
-> FilePath
-> a
-> IO Bool	result of `Files.writeGz`.

serialize_rotate :: Serialize a => Int.Int -> Magic a -> FilePath -> a -> IO Bool Source #

data UnserializeError Source #

Constructors

BadMagic ByteString.ByteString ByteString.ByteString
IOError IO.Error.IOError
UnserializeError String

Instances

Instances details

Show UnserializeError Source #
Instance details Defined in Util.Serialize Methods showsPrec :: Int.Int -> UnserializeError -> ShowS # show :: UnserializeError -> String # showList :: [UnserializeError] -> ShowS #
Pretty UnserializeError Source #
Instance details Defined in Util.Serialize Methods pretty :: UnserializeError -> Text Source # format :: UnserializeError -> Doc Source # formatList :: [UnserializeError] -> Doc Source #

unserialize :: Serialize a => Magic a -> FilePath -> IO (Either UnserializeError a) Source #

util

get_tag :: Get Word.Word8 Source #

put_tag :: Word.Word8 -> Put Source #

bad_tag :: String -> Word.Word8 -> Get a Source #

get_enum :: Get Word.Word8 Source #

put_enum :: Word.Word8 -> Put Source #

It's just put, but make sure it's using Int. Word8 would be more suitable.

bad_enum :: String -> Word.Word8 -> Get a Source #

get_enum_unsafe :: (Bounded a, Enum a) => Get a Source #

These are convenient but dangerous. If they are are used in a context where backward compatibility matters (Cmd.Serialize) then it's too easy to break compatibility by adding or removing an enum.

But they're fine if used in an enum that will never change, or where compatibility doesn't matter.

put_enum_unsafe :: Enum a => a -> Put Source #

versions

get_version :: Get Word.Word8 Source #

put_version :: Word.Word8 -> Put Source #

bad_version :: CallStack.Stack => String -> Word.Word8 -> a Source #