Modulebytes-0.17.4Haskell2010

Data.Bytes.Serial

This module contains two main classes, each providing methods to serialize and deserialize types. Serial is the primary class, to be used for the canonical way to serialize a specific type. SerialEndian is used to provide endian-specific methods for serializing a type.

7 classes
6 values

Packagebytes-0.17.4
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSerial.hs

Serialization

1 declaration

classclass Serial a where

Methods to serialize and deserialize type a to a binary representation

Instances provided here for fixed-with Integers and Words are big endian. Instances for strict and lazy bytestrings store also the length of bytestring big endian. Instances for Word and Int are host endian as they are machine-specific types.

Methods

serialize :: MonadPut m => a -> m ()
deserialize :: MonadGet m => m a

Instances66Serial, …

Serial ByteStringDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial ByteStringDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial IntSetDefined in bytes-0.17.4 · Data.Bytes.Serial

Serial IntegerDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> (runGetL deserialize $ runPutL $ serialize (1822304234^100::Integer))::Integer115368812579128172803867366576339947332796540054052185472042218522037227934707037623902492207671987696439966697503243972076991940820348847422930433939639982092916577692754723458548819441583937289395076910527534916776189405228720063994377687015476947534961767053653973945346259230972683338173842343243493433367681264359887291905132383269175086733345253389374961758293922003996035662362278340494093804835649459223465051596978792130073960666112508481814461273829244289795707398202762289955919352549768394583446336873179280924584333491364188425976869717125645749497258775598562132278030402205794994603544837805140410310712693778605743100915046769381631247123664460203591228745772887977959388457679427407639421147498028487544882346912935398848298806021505673449774474457435816552278997100556732447852816961683577731381792363312695347606768120122976105200574809419685234274705929886121600174028733812771637390342332436695318974693376

Serial NaturalDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> runGetL deserialize (runPutL (serialize (10^10::Natural))) :: Natural10000000000

Serial VoidDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial AllDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial AnyDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial VersionDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial Int16Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Int32Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Int64Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Int8Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Word16Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Word32Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Word64Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial Word8Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial BoolDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial CharDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial DoubleDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial FloatDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial IntDefined in bytes-0.17.4 · Data.Bytes.Serial

Serial OrderingDefined in bytes-0.17.4 · Data.Bytes.Serial

Example3 expressions

>>> runGetL deserialize $ runPutL $ serialize LT::OrderingLT>>> runGetL deserialize $ runPutL $ serialize EQ::OrderingEQ>>> runGetL deserialize $ runPutL $ serialize GT::OrderingGT

Serial WordDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial ScientificDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial TextDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial TextDefined in bytes-0.17.4 · Data.Bytes.Serial

Serial DayDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> (runGetL deserialize $ runPutL $ serialize (ModifiedJulianDay 1))::Day1858-11-18

Serial AbsoluteTimeDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> (runGetL deserialize $ runPutL $ serialize (addAbsoluteTime 18.2 taiEpoch))::AbsoluteTime1858-11-17 00:00:18.2 TAI

Serial DiffTimeDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> (runGetL deserialize $ runPutL $ serialize (1.82::DiffTime))::DiffTime1.82s

Serial NominalDiffTimeDefined in bytes-0.17.4 · Data.Bytes.Serial
Example1 expression
```
>>> (runGetL deserialize $ runPutL $ serialize (1.82::DiffTime))::DiffTime1.82s
```

Serial UTCTimeDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> (runGetL deserialize $ runPutL $ serialize (read "2014-01-01 10:54:42.478031 UTC"::UTCTime))::UTCTime2014-01-01 10:54:42.478031 UTC

Serial UniversalTimeDefined in bytes-0.17.4 · Data.Bytes.Serial

Example1 expression

>>> getModJulianDate $ (runGetL deserialize $ runPutL $ serialize (ModJulianDate $ 5 % 11)::UniversalTime)5 % 11

Serial LocalTimeDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial TimeOfDayDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial TimeZoneDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial ZonedTimeDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial ()Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Seq a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (NonEmpty a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Identity a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (First a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Last a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Down a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Dual a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Product a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Sum a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (ZipList a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Maybe a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial [a]Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial v => Serial (IntMap v)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Integral a) => Serial (Ratio a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Example1 expression
```
>>> (runGetL deserialize $ runPutL $ serialize (5 % 11::Ratio Int))::Ratio Int5 % 11
```
(Serial a, Ord a) => Serial (Set a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial v, Hashable v, Eq v) => Serial (HashSet v)Defined in bytes-0.17.4 · Data.Bytes.Serial

(Bits n, Integral n, Bits (Unsigned n), Integral (Unsigned n)) => Serial (VarInt n)Defined in bytes-0.17.4 · Data.Bytes.Serial

Integer/Word types serialized to base-128 variable-width ints.

Example4 expressions

>>> import Data.Monoid (mconcat)>>> import qualified Data.ByteString.Lazy as BSL>>> mconcat $ BSL.toChunks $ runPutL $ serialize (97 :: Word64)"\NUL\NUL\NUL\NUL\NUL\NUL\NULa">>> mconcat $ BSL.toChunks $ runPutL $ serialize (97 :: VarInt Word64)"a"

HasResolution a => Serial (Fixed a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Example1 expression
```
>>> (runGetL deserialize $ runPutL $ serialize (1.82::Fixed E2))::Fixed E21.82
```
(Serial a, Serial b) => Serial (Either a b)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b) => Serial (a, b)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial k, Serial v, Ord k) => Serial (Map k v)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial k, Serial v, Hashable k, Eq k) => Serial (HashMap k v)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial (f a) => Serial (Reverse f a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial (Constant a b)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c) => Serial (a, b, c)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial (f a), Serial (g a)) => Serial (Product f g a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c, Serial d) => Serial (a, b, c, d)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c, Serial d, Serial e) => Serial (a, b, c, d, e)Defined in bytes-0.17.4 · Data.Bytes.Serial

Specifying endianness

1 declaration

classclass SerialEndian a where

Methods to serialize and deserialize type a to a big and little endian binary representations. Methods suffixed with "host" are automatically defined to use equal the methods corresponding to the current machine's native endianness, but they can be overridden.

Methods

serializeBE :: MonadPut m => a -> m ()
deserializeBE :: MonadGet m => m a
serializeLE :: MonadPut m => a -> m ()
deserializeLE :: MonadGet m => m a
serializeHost :: MonadPut m => a -> m ()
deserializeHost :: MonadGet m => m a

Instances9SerialEndian, …

SerialEndian Int16Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian Int32Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian Int64Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian Word16Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian Word32Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian Word64Defined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian CharDefined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian DoubleDefined in bytes-0.17.4 · Data.Bytes.Serial
SerialEndian FloatDefined in bytes-0.17.4 · Data.Bytes.Serial

Higher-order

6 declarations

These classes provide us with the ability to serialize containers that need polymorphic recursion.

classclass Serial1 (f :: Type -> Type) where

Methods

serializeWith :: MonadPut m => (a -> m ()) -> f a -> m ()
deserializeWith :: MonadGet m => m a -> m (f a)

Instances12Serial1, …

Serial1 IntMapDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial1 SeqDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial1 NonEmptyDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial1 MaybeDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial1 []Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial1 (Either a)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial1 (Tuple2 a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Ord k, Serial k) => Serial1 (Map k)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Hashable k, Eq k, Serial k) => Serial1 (HashMap k)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b) => Serial1 (Tuple3 a b)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c) => Serial1 (Tuple4 a b c)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c, Serial d) => Serial1 (Tuple5 a b c d)Defined in bytes-0.17.4 · Data.Bytes.Serial

valueserialize1 :: (MonadPut m, Serial1 f, Serial a) => f a -> m ()

valuedeserialize1 :: (MonadGet m, Serial1 f, Serial a) => m (f a)

classclass Serial2 (f :: Type -> Type -> Type) where

Methods

serializeWith2 :: MonadPut m => (a -> m ()) -> (b -> m ()) -> f a b -> m ()
deserializeWith2 :: MonadGet m => m a -> m b -> m (f a b)

Instances5Serial2

Serial2 EitherDefined in bytes-0.17.4 · Data.Bytes.Serial
Serial2 Tuple2Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => Serial2 (Tuple3 a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b) => Serial2 (Tuple4 a b)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial a, Serial b, Serial c) => Serial2 (Tuple5 a b c)Defined in bytes-0.17.4 · Data.Bytes.Serial

valueserialize2 :: (MonadPut m, Serial2 f, Serial a, Serial b) => f a b -> m ()

valuedeserialize2 :: (MonadGet m, Serial2 f, Serial a, Serial b) => m (f a b)

Storable

2 declarations

valuestore :: (MonadPut m, Storable a) => a -> m ()

serialize any Storable in a host-specific format.

valuerestore :: (MonadGet m, Storable a) => m a

deserialize any Storable in a host-specific format.

Generics

3 declarations

You probably will never need to care that these exist except they provide us with default definitions for Serial and SerialEndian

classclass GSerial (f :: Type -> Type) where

Used internally to provide generic serialization

Methods

gserialize :: MonadPut m => f a -> m ()
gdeserialize :: MonadGet m => m (f a)

Instances6GSerial

GSerial U1Defined in bytes-0.17.4 · Data.Bytes.Serial
GSerial V1Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => GSerial (K1 i a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(GSerial f, GSerial g) => GSerial (f :*: g)Defined in bytes-0.17.4 · Data.Bytes.Serial
(GSerial f, GSerial g) => GSerial (f :+: g)Defined in bytes-0.17.4 · Data.Bytes.Serial
GSerial f => GSerial (M1 i c f)Defined in bytes-0.17.4 · Data.Bytes.Serial

classclass GSerialEndian (f :: Type -> Type) where

Used internally to provide generic big-endian serialization

Methods

gserializeBE :: MonadPut m => f a -> m ()
gdeserializeBE :: MonadGet m => m (f a)
gserializeLE :: MonadPut m => f a -> m ()
gdeserializeLE :: MonadGet m => m (f a)

Instances1GSerialEndian

SerialEndian a => GSerialEndian (K1 i a)Defined in bytes-0.17.4 · Data.Bytes.Serial

classclass GSerial1 (f :: Type -> Type) where

Used internally to provide generic serialization

Methods

gserializeWith :: MonadPut m => (a -> m ()) -> f a -> m ()
gdeserializeWith :: MonadGet m => m a -> m (f a)

Instances9GSerial1, …

GSerial1 Par1Defined in bytes-0.17.4 · Data.Bytes.Serial
GSerial1 U1Defined in bytes-0.17.4 · Data.Bytes.Serial
GSerial1 V1Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial1 f => GSerial1 (Rec1 f)Defined in bytes-0.17.4 · Data.Bytes.Serial
Serial a => GSerial1 (K1 i a)Defined in bytes-0.17.4 · Data.Bytes.Serial
(GSerial1 f, GSerial1 g) => GSerial1 (f :*: g)Defined in bytes-0.17.4 · Data.Bytes.Serial
(GSerial1 f, GSerial1 g) => GSerial1 (f :+: g)Defined in bytes-0.17.4 · Data.Bytes.Serial
GSerial1 f => GSerial1 (M1 i c f)Defined in bytes-0.17.4 · Data.Bytes.Serial
(Serial1 f, GSerial1 g) => GSerial1 (f :.: g)Defined in bytes-0.17.4 · Data.Bytes.Serial