Moduledata-serializer-0.3.5Haskell2010

Data.Serializer

Serialization monoid and serializable types.

Contents

Serialization monoid
Binary words serialization
Endian serializers
Serializable types

Synopsis

class Serializer
value buildBytes
value buildByteString
value buildLazyByteString
newtype BinarySerializer
newtype CerealSerializer
value word16H
value word32H
value word64H
value word
value wordL
value wordB
value wordH
value int8
value int16
value int16L
value int16B
value int16H
value int32
value int32L
value int32B
value int32H
value int64
value int64L
value int64B
value int64H
value int
value intL
value intB
value intH
newtype LittleEndianSerializer
newtype BigEndianSerializer
value serializeIn
value serializeH
class Serializable
value putIn
value putL
value putB
value putH
value toBytes
value toByteString
value toLazyByteString
class SizedSerializable
class RestSerializable

Packagedata-serializer-0.3.5
Exports44
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSerializer.hs

Serialization monoid

classclass (Semigroup s, Monoid s) => Serializer s where

Source#

Serialization monoid.

Methods

endian :: Proxy s -> Endian
Default byte order of the serializer.
word8 :: Word8 -> s
Serialize a byte. word8 x = byteString (singleton x)
word16 :: Word16 -> s
Serialize an unsigned 16-bit integer in the default byte order.
word32 :: Word32 -> s
Serialize an unsigned 32-bit integer in the default byte order.
word64 :: Word64 -> s
Serialize an unsigned 64-bit integer in the default byte order.
word16L :: Word16 -> s
Serialize an unsigned 16-bit integer in little endian.
word16B :: Word16 -> s
Serialize an unsigned 16-bit integer in big endian.
word32L :: Word32 -> s
Serialize an unsigned 32-bit integer in little endian.
word32B :: Word32 -> s
Serialize an unsigned 32-bit integer in big endian.
word64L :: Word64 -> s
Serialize an unsigned 64-bit integer in little endian.
word64B :: Word64 -> s
Serialize an unsigned 64-bit integer in big endian.
byteString :: ByteString -> s
Serialize a ByteString. Must be a monoid homomorphism.
shortByteString :: ShortByteString -> s
Serialize a ShortByteString. Must be a monoid homomorphism.
lazyByteString :: ByteString -> s
Serialize a lazy ByteString. Must be a monoid homomorphism.
builder :: Builder -> s
Serialize a Builder. Must be a monoid homomorphism.

Instances7Serializer, …

Serializer PutDefined in data-serializer-0.3.5 · Data.Serializer
Serializer BuilderDefined in data-serializer-0.3.5 · Data.Serializer
Serializer BinarySerializerDefined in data-serializer-0.3.5 · Data.Serializer
Serializer CerealSerializerDefined in data-serializer-0.3.5 · Data.Serializer
Serializer [Word8]Defined in data-serializer-0.3.5 · Data.Serializer
Serializer s => Serializer (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Serializer s => Serializer (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer

valuebuildBytes :: Builder -> [Word8]

Source#

A shorthand for "LBS.unpack' . toLazyByteString.

valuebuildByteString :: Builder -> ByteString

Source#

A shorthand for toStrict . toLazyByteString.

valuebuildLazyByteString :: Builder -> ByteString

Source#

An alias for toLazyByteString.

newtypenewtype BinarySerializer

Source#

A wrapper around the Put monoid (to avoid orphan instances).

Constructors

BinarySerializer
- binarySerializer :: Put

Instances5Generic, Semigroup, Monoid, Serializer, Rep

Generic BinarySerializerDefined in data-serializer-0.3.5 · Data.Serializer
Semigroup BinarySerializerDefined in data-serializer-0.3.5 · Data.Serializer
Monoid BinarySerializerDefined in data-serializer-0.3.5 · Data.Serializer
Serializer BinarySerializerDefined in data-serializer-0.3.5 · Data.Serializer
type Rep BinarySerializer = D1 ('MetaData "BinarySerializer" "Data.Serializer" "data-serializer-0.3.5-44omE2WbEFW7kUSH94hHGp" 'True) (C1 ('MetaCons "BinarySerializer" 'PrefixI 'True) (S1 ('MetaSel ('Just "binarySerializer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Put)))Defined in data-serializer-0.3.5 · Data.Serializer

newtypenewtype CerealSerializer

Source#

A wrapper around the Put monoid (to avoid orphan instances).

Constructors

CerealSerializer
- cerealSerializer :: Put

Instances5Generic, Semigroup, Monoid, Serializer, Rep

Generic CerealSerializerDefined in data-serializer-0.3.5 · Data.Serializer
Semigroup CerealSerializerDefined in data-serializer-0.3.5 · Data.Serializer
Monoid CerealSerializerDefined in data-serializer-0.3.5 · Data.Serializer
Serializer CerealSerializerDefined in data-serializer-0.3.5 · Data.Serializer
type Rep CerealSerializer = D1 ('MetaData "CerealSerializer" "Data.Serializer" "data-serializer-0.3.5-44omE2WbEFW7kUSH94hHGp" 'True) (C1 ('MetaCons "CerealSerializer" 'PrefixI 'True) (S1 ('MetaSel ('Just "cerealSerializer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Put)))Defined in data-serializer-0.3.5 · Data.Serializer

Binary words serialization

valueword16H :: Serializer s => Word16 -> s

Source#

Serialize an usigned 16-bit integer in host byte order.

valueword32H :: Serializer s => Word32 -> s

Source#

Serialize an unsigned 32-bit integer in host byte order.

valueword64H :: Serializer s => Word64 -> s

Source#

Serialize an unsigned 64-bit integer in host byte order.

valueword :: Serializer s => Word -> s

Source#

Serialize an unsigned native-sized integer in serializer default byte order.

valuewordL :: Serializer s => Word -> s

Source#

Serialize an unsigned native-sized integer in little endian.

valuewordB :: Serializer s => Word -> s

Source#

Serialize an unsigned native-sized integer in big endian.

valuewordH :: Serializer s => Word -> s

Source#

Serialize an unsigned native-sized integer in host byte order.

valueint8 :: Serializer s => Int8 -> s

Source#

Serialize a signed 8-bit integer.

valueint16 :: Serializer s => Int16 -> s

Source#

Serialize a signed 16-bit integer in serializer default byte order.

valueint16L :: Serializer s => Int16 -> s

Source#

Serialize a signed 16-bit integer in little endian.

valueint16B :: Serializer s => Int16 -> s

Source#

Serialize a signed 16-bit integer in big endian.

valueint16H :: Serializer s => Int16 -> s

Source#

Serialize a signed 16-bit integer in host byte order.

valueint32 :: Serializer s => Int32 -> s

Source#

Serialize a signed 32-bit integer in serializer default byte order.

valueint32L :: Serializer s => Int32 -> s

Source#

Serialize a signed 32-bit integer in little endian.

valueint32B :: Serializer s => Int32 -> s

Source#

Serialize a signed 32-bit integer in big endian.

valueint32H :: Serializer s => Int32 -> s

Source#

Serialize a signed 32-bit integer in host byte order.

valueint64 :: Serializer s => Int64 -> s

Source#

Serialize a signed 64-bit integer in serializer default byte order.

valueint64L :: Serializer s => Int64 -> s

Source#

Serialize a signed 64-bit integer in little endian.

valueint64B :: Serializer s => Int64 -> s

Source#

Serialize a signed 64-bit integer in big endian.

valueint64H :: Serializer s => Int64 -> s

Source#

Serialize a signed 64-bit integer in host byte order.

valueint :: Serializer s => Int -> s

Source#

Serialize a signed native-sized integer in serializer default byte order.

valueintL :: Serializer s => Int -> s

Source#

Serialize a signed native-sized integer in little endian.

valueintB :: Serializer s => Int64 -> s

Source#

Serialize a signed native-sized integer in big endian.

valueintH :: Serializer s => Int -> s

Source#

Serialize a signed native-sized integer in host byte order.

Endian serializers

newtypenewtype LittleEndianSerializer s

Source#

Serializer wrapper with little endian default byte order.

Constructors

LittleEndianSerializer
- serializeL :: s

Instances6Data, Generic, Semigroup, Monoid, Serializer, Rep

Data s => Data (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Generic (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Semigroup s => Semigroup (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Monoid s => Monoid (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Serializer s => Serializer (LittleEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
type Rep (LittleEndianSerializer s) = D1 ('MetaData "LittleEndianSerializer" "Data.Serializer" "data-serializer-0.3.5-44omE2WbEFW7kUSH94hHGp" 'True) (C1 ('MetaCons "LittleEndianSerializer" 'PrefixI 'True) (S1 ('MetaSel ('Just "serializeL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 s)))Defined in data-serializer-0.3.5 · Data.Serializer

newtypenewtype BigEndianSerializer s

Source#

Serializer wrapper with big endian default byte order.

Constructors

BigEndianSerializer
- serializeB :: s

Instances6Data, Generic, Semigroup, Monoid, Serializer, Rep

Data s => Data (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Generic (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Semigroup s => Semigroup (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Monoid s => Monoid (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
Serializer s => Serializer (BigEndianSerializer s)Defined in data-serializer-0.3.5 · Data.Serializer
type Rep (BigEndianSerializer s) = D1 ('MetaData "BigEndianSerializer" "Data.Serializer" "data-serializer-0.3.5-44omE2WbEFW7kUSH94hHGp" 'True) (C1 ('MetaCons "BigEndianSerializer" 'PrefixI 'True) (S1 ('MetaSel ('Just "serializeB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 s)))Defined in data-serializer-0.3.5 · Data.Serializer

valueserializeIn

:: Serializer s
=> Endian
-> forall s'. Serializer s' => s'
-> s

Source#

Force the default byte order.

valueserializeH :: Serializer s => (forall s'. Serializer s' => s') -> s

Source#

Force the default byte order to be the host byte order.

Serializable types

classclass Serializable α where

Source#

Serializable type. put must work under assumption that it will be followed by more output.

Methods

put :: Serializer s => α -> s

Instances16Serializable, …

Serializable ByteStringDefined in data-serializer-0.3.5 · Data.Serializer
Serializable ShortByteStringDefined in data-serializer-0.3.5 · Data.Serializer
Serializable Int16Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Int32Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Int64Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Int8Defined in data-serializer-0.3.5 · Data.Serializer
Serializable BoolDefined in data-serializer-0.3.5 · Data.Serializer
Serializable IntDefined in data-serializer-0.3.5 · Data.Serializer
Serializable WordDefined in data-serializer-0.3.5 · Data.Serializer
Serializable Word16Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Word32Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Word64Defined in data-serializer-0.3.5 · Data.Serializer
Serializable Word8Defined in data-serializer-0.3.5 · Data.Serializer
Serializable α => Serializable (Maybe α)Defined in data-serializer-0.3.5 · Data.Serializer
(Serializable α, Serializable β) => Serializable (Either α β)Defined in data-serializer-0.3.5 · Data.Serializer
(Serializable α, Serializable β) => Serializable (α, β)Defined in data-serializer-0.3.5 · Data.Serializer

valueputIn :: (Serializer s, Serializable α) => Endian -> α -> s

Source#

Serialize a value using the provided default byte order.

valueputL :: (Serializer s, Serializable α) => α -> s

Source#

Serialize a value using little endian as the default byte order.

valueputB :: (Serializer s, Serializable α) => α -> s

Source#

Serialize a value using big endian as the default byte order.

valueputH :: (Serializer s, Serializable α) => α -> s

Source#

Serialize a value using host byte order as the default byte order.

valuetoBytes :: Serializable α => α -> [Word8]

Source#

A shorthand for buildBytes . put.

valuetoByteString :: Serializable α => α -> ByteString

Source#

A shorthand for buildByteString . put.

valuetoLazyByteString :: Serializable α => α -> ByteString

Source#

A shorthand for buildLazyByteString . put.

classclass Serializable α => SizedSerializable α where

Source#

Types with fixed serialized size.

Methods

size :: Proxy α -> Int
Serialized size in bytes.

Instances12SizedSerializable, …

SizedSerializable Int16Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Int32Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Int64Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Int8Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable BoolDefined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable IntDefined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable WordDefined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Word16Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Word32Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Word64Defined in data-serializer-0.3.5 · Data.Serializer
SizedSerializable Word8Defined in data-serializer-0.3.5 · Data.Serializer
(SizedSerializable α, SizedSerializable β) => SizedSerializable (α, β)Defined in data-serializer-0.3.5 · Data.Serializer

classclass RestSerializable α where

Source#

Serializable type. putRest must work under assumption that it will not be followed by any more output.

Methods

putRest :: Serializer s => α -> s

Instances6RestSerializable

RestSerializable BuilderDefined in data-serializer-0.3.5 · Data.Serializer
RestSerializable ByteStringDefined in data-serializer-0.3.5 · Data.Serializer
RestSerializable ByteStringDefined in data-serializer-0.3.5 · Data.Serializer
RestSerializable ShortByteStringDefined in data-serializer-0.3.5 · Data.Serializer
Serializable α => RestSerializable [α]Defined in data-serializer-0.3.5 · Data.Serializer
(Serializable α, RestSerializable β) => RestSerializable (α, β)Defined in data-serializer-0.3.5 · Data.Serializer