Copyright	(C) 2015 Oleg Grenrus
License	BSD3
Maintainer	Oleg Grenrus <oleg.grenrus@iki.fi>
Safe Haskell	None
Language	Haskell2010

Data.Binary.Orphans

Contents

Class re-export
Module re-export
Orphan instances

Description

Provides orphan Binary instances for types in various packages:

aeson
scientific (prior to scientific-0.3.4.0)
semigroups
tagged
text (through text-binary, or text >= 1.2.1)
time
unordered-containers
vector (through vector-binary-instances)

Also there is Binary Fixed instance.

Synopsis

class Binary t where
- put :: t -> Put
- get :: Get t
- putList :: [t] -> Put
module Data.Binary

Class re-export

class Binary t where Source #

The Binary class provides put and get, methods to encode and decode a Haskell value to a lazy ByteString. It mirrors the Read and Show classes for textual representation of Haskell types, and is suitable for serialising Haskell values to disk, over the network.

For decoding and generating simple external binary formats (e.g. C structures), Binary may be used, but in general is not suitable for complex protocols. Instead use the PutM and Get primitives directly.

Instances of Binary should satisfy the following property:

decode . encode == id

That is, the get and put methods should be the inverse of each other. A range of instances are provided for basic Haskell types.

Minimal complete definition

Nothing

Methods

put :: t -> Put Source #

Encode a value in the Put monad.

get :: Get t Source #

Decode a value in the Get monad

putList :: [t] -> Put Source #

Encode a list of values in the Put monad. The default implementation may be overridden to be more efficient but must still have the same encoding format.

Instances

Binary Bool
Instance details Defined in Data.Binary.Class Methods put :: Bool -> Put Source # get :: Get Bool Source # putList :: [Bool] -> Put Source #
Binary Char
Instance details Defined in Data.Binary.Class Methods put :: Char -> Put Source # get :: Get Char Source # putList :: [Char] -> Put Source #
Binary Double
Instance details Defined in Data.Binary.Class Methods put :: Double -> Put Source # get :: Get Double Source # putList :: [Double] -> Put Source #
Binary Float
Instance details Defined in Data.Binary.Class Methods put :: Float -> Put Source # get :: Get Float Source # putList :: [Float] -> Put Source #
Binary Int
Instance details Defined in Data.Binary.Class Methods put :: Int -> Put Source # get :: Get Int Source # putList :: [Int] -> Put Source #
Binary Int8
Instance details Defined in Data.Binary.Class Methods put :: Int8 -> Put Source # get :: Get Int8 Source # putList :: [Int8] -> Put Source #
Binary Int16
Instance details Defined in Data.Binary.Class Methods put :: Int16 -> Put Source # get :: Get Int16 Source # putList :: [Int16] -> Put Source #
Binary Int32
Instance details Defined in Data.Binary.Class Methods put :: Int32 -> Put Source # get :: Get Int32 Source # putList :: [Int32] -> Put Source #
Binary Int64
Instance details Defined in Data.Binary.Class Methods put :: Int64 -> Put Source # get :: Get Int64 Source # putList :: [Int64] -> Put Source #
Binary Integer
Instance details Defined in Data.Binary.Class Methods put :: Integer -> Put Source # get :: Get Integer Source # putList :: [Integer] -> Put Source #
Binary Natural	Since: 0.7.3.0
Instance details Defined in Data.Binary.Class Methods put :: Natural -> Put Source # get :: Get Natural Source # putList :: [Natural] -> Put Source #
Binary Ordering
Instance details Defined in Data.Binary.Class Methods put :: Ordering -> Put Source # get :: Get Ordering Source # putList :: [Ordering] -> Put Source #
Binary Word
Instance details Defined in Data.Binary.Class Methods put :: Word -> Put Source # get :: Get Word Source # putList :: [Word] -> Put Source #
Binary Word8
Instance details Defined in Data.Binary.Class Methods put :: Word8 -> Put Source # get :: Get Word8 Source # putList :: [Word8] -> Put Source #
Binary Word16
Instance details Defined in Data.Binary.Class Methods put :: Word16 -> Put Source # get :: Get Word16 Source # putList :: [Word16] -> Put Source #
Binary Word32
Instance details Defined in Data.Binary.Class Methods put :: Word32 -> Put Source # get :: Get Word32 Source # putList :: [Word32] -> Put Source #
Binary Word64
Instance details Defined in Data.Binary.Class Methods put :: Word64 -> Put Source # get :: Get Word64 Source # putList :: [Word64] -> Put Source #
Binary RuntimeRep	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: RuntimeRep -> Put Source # get :: Get RuntimeRep Source # putList :: [RuntimeRep] -> Put Source #
Binary VecCount	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: VecCount -> Put Source # get :: Get VecCount Source # putList :: [VecCount] -> Put Source #
Binary VecElem	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: VecElem -> Put Source # get :: Get VecElem Source # putList :: [VecElem] -> Put Source #
Binary SomeTypeRep
Instance details Defined in Data.Binary.Class Methods put :: SomeTypeRep -> Put Source # get :: Get SomeTypeRep Source # putList :: [SomeTypeRep] -> Put Source #
Binary ()
Instance details Defined in Data.Binary.Class Methods put :: () -> Put Source # get :: Get () Source # putList :: [()] -> Put Source #
Binary TyCon	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: TyCon -> Put Source # get :: Get TyCon Source # putList :: [TyCon] -> Put Source #
Binary KindRep	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: KindRep -> Put Source # get :: Get KindRep Source # putList :: [KindRep] -> Put Source #
Binary TypeLitSort	@since 0.8.5.0. See
Instance details Defined in Data.Binary.Class Methods put :: TypeLitSort -> Put Source # get :: Get TypeLitSort Source # putList :: [TypeLitSort] -> Put Source #
Binary ByteString
Instance details Defined in Data.Binary.Class Methods put :: ByteString -> Put Source # get :: Get ByteString Source # putList :: [ByteString] -> Put Source #
Binary ByteString
Instance details Defined in Data.Binary.Class Methods put :: ByteString -> Put Source # get :: Get ByteString Source # putList :: [ByteString] -> Put Source #
Binary Scientific	Note that in the future I intend to change the type of the `base10Exponent` from `Int` to `Integer`. To be forward compatible the `Binary` instance already encodes the exponent as `Integer`.
Instance details Defined in Data.Scientific Methods put :: Scientific -> Put Source # get :: Get Scientific Source # putList :: [Scientific] -> Put Source #
Binary UTCTime Source #
Instance details Defined in Data.Binary.Orphans Methods put :: UTCTime -> Put Source # get :: Get UTCTime Source # putList :: [UTCTime] -> Put Source #
Binary Value Source #
Instance details Defined in Data.Binary.Orphans Methods put :: Value -> Put Source # get :: Get Value Source # putList :: [Value] -> Put Source #
Binary Void	Since: 0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Void -> Put Source # get :: Get Void Source # putList :: [Void] -> Put Source #
Binary Version	Since: 0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Version -> Put Source # get :: Get Version Source # putList :: [Version] -> Put Source #
Binary All	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: All -> Put Source # get :: Get All Source # putList :: [All] -> Put Source #
Binary Any	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Any -> Put Source # get :: Get Any Source # putList :: [Any] -> Put Source #
Binary Fingerprint	Since: 0.7.6.0
Instance details Defined in Data.Binary.Class Methods put :: Fingerprint -> Put Source # get :: Get Fingerprint Source # putList :: [Fingerprint] -> Put Source #
Binary ShortByteString
Instance details Defined in Data.Binary.Class Methods put :: ShortByteString -> Put Source # get :: Get ShortByteString Source # putList :: [ShortByteString] -> Put Source #
Binary IntSet
Instance details Defined in Data.Binary.Class Methods put :: IntSet -> Put Source # get :: Get IntSet Source # putList :: [IntSet] -> Put Source #
Binary ZonedTime Source #	Since: binary-orphans-0.1.8.0
Instance details Defined in Data.Binary.Orphans Methods put :: ZonedTime -> Put Source # get :: Get ZonedTime Source # putList :: [ZonedTime] -> Put Source #
Binary LocalTime Source #
Instance details Defined in Data.Binary.Orphans Methods put :: LocalTime -> Put Source # get :: Get LocalTime Source # putList :: [LocalTime] -> Put Source #
Binary TimeOfDay Source #
Instance details Defined in Data.Binary.Orphans Methods put :: TimeOfDay -> Put Source # get :: Get TimeOfDay Source # putList :: [TimeOfDay] -> Put Source #
Binary TimeZone Source #
Instance details Defined in Data.Binary.Orphans Methods put :: TimeZone -> Put Source # get :: Get TimeZone Source # putList :: [TimeZone] -> Put Source #
Binary UniversalTime Source #
Instance details Defined in Data.Binary.Orphans Methods put :: UniversalTime -> Put Source # get :: Get UniversalTime Source # putList :: [UniversalTime] -> Put Source #
Binary SystemTime Source #	Since: binary-orphans-0.1.7.0
Instance details Defined in Data.Binary.Orphans Methods put :: SystemTime -> Put Source # get :: Get SystemTime Source # putList :: [SystemTime] -> Put Source #
Binary NominalDiffTime Source #
Instance details Defined in Data.Binary.Orphans Methods put :: NominalDiffTime -> Put Source # get :: Get NominalDiffTime Source # putList :: [NominalDiffTime] -> Put Source #
Binary AbsoluteTime Source #	Since: binary-orphans-0.1.4.0
Instance details Defined in Data.Binary.Orphans Methods put :: AbsoluteTime -> Put Source # get :: Get AbsoluteTime Source # putList :: [AbsoluteTime] -> Put Source #
Binary DiffTime Source #
Instance details Defined in Data.Binary.Orphans Methods put :: DiffTime -> Put Source # get :: Get DiffTime Source # putList :: [DiffTime] -> Put Source #
Binary Day Source #
Instance details Defined in Data.Binary.Orphans Methods put :: Day -> Put Source # get :: Get Day Source # putList :: [Day] -> Put Source #
Binary a => Binary [a]
Instance details Defined in Data.Binary.Class Methods put :: [a] -> Put Source # get :: Get [a] Source # putList :: [[a]] -> Put Source #
Binary a => Binary (Maybe a)
Instance details Defined in Data.Binary.Class Methods put :: Maybe a -> Put Source # get :: Get (Maybe a) Source # putList :: [Maybe a] -> Put Source #
(Binary a, Integral a) => Binary (Ratio a)
Instance details Defined in Data.Binary.Class Methods put :: Ratio a -> Put Source # get :: Get (Ratio a) Source # putList :: [Ratio a] -> Put Source #
Binary a => Binary (Complex a)
Instance details Defined in Data.Binary.Class Methods put :: Complex a -> Put Source # get :: Get (Complex a) Source # putList :: [Complex a] -> Put Source #
Binary (Fixed a)	Since: 0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Fixed a -> Put Source # get :: Get (Fixed a) Source # putList :: [Fixed a] -> Put Source #
Binary a => Binary (Min a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Min a -> Put Source # get :: Get (Min a) Source # putList :: [Min a] -> Put Source #
Binary a => Binary (Max a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Max a -> Put Source # get :: Get (Max a) Source # putList :: [Max a] -> Put Source #
Binary a => Binary (First a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: First a -> Put Source # get :: Get (First a) Source # putList :: [First a] -> Put Source #
Binary a => Binary (Last a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Last a -> Put Source # get :: Get (Last a) Source # putList :: [Last a] -> Put Source #
Binary m => Binary (WrappedMonoid m)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: WrappedMonoid m -> Put Source # get :: Get (WrappedMonoid m) Source # putList :: [WrappedMonoid m] -> Put Source #
Binary a => Binary (Option a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Option a -> Put Source # get :: Get (Option a) Source # putList :: [Option a] -> Put Source #
Binary a => Binary (Identity a)
Instance details Defined in Data.Binary.Class Methods put :: Identity a -> Put Source # get :: Get (Identity a) Source # putList :: [Identity a] -> Put Source #
Binary a => Binary (First a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: First a -> Put Source # get :: Get (First a) Source # putList :: [First a] -> Put Source #
Binary a => Binary (Last a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Last a -> Put Source # get :: Get (Last a) Source # putList :: [Last a] -> Put Source #
Binary a => Binary (Dual a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Dual a -> Put Source # get :: Get (Dual a) Source # putList :: [Dual a] -> Put Source #
Binary a => Binary (Sum a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Sum a -> Put Source # get :: Get (Sum a) Source # putList :: [Sum a] -> Put Source #
Binary a => Binary (Product a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Product a -> Put Source # get :: Get (Product a) Source # putList :: [Product a] -> Put Source #
Binary a => Binary (NonEmpty a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: NonEmpty a -> Put Source # get :: Get (NonEmpty a) Source # putList :: [NonEmpty a] -> Put Source #
(FoldCase a, Binary a) => Binary (CI a) Source #	Since: binary-orphans-0.1.5.0
Instance details Defined in Data.Binary.Orphans Methods put :: CI a -> Put Source # get :: Get (CI a) Source # putList :: [CI a] -> Put Source #
Binary e => Binary (IntMap e)
Instance details Defined in Data.Binary.Class Methods put :: IntMap e -> Put Source # get :: Get (IntMap e) Source # putList :: [IntMap e] -> Put Source #
Binary e => Binary (Tree e)
Instance details Defined in Data.Binary.Class Methods put :: Tree e -> Put Source # get :: Get (Tree e) Source # putList :: [Tree e] -> Put Source #
Binary e => Binary (Seq e)
Instance details Defined in Data.Binary.Class Methods put :: Seq e -> Put Source # get :: Get (Seq e) Source # putList :: [Seq e] -> Put Source #
Binary a => Binary (Set a)
Instance details Defined in Data.Binary.Class Methods put :: Set a -> Put Source # get :: Get (Set a) Source # putList :: [Set a] -> Put Source #
(Hashable a, Binary a) => Binary (Hashed a) Source #
Instance details Defined in Data.Binary.Orphans Methods put :: Hashed a -> Put Source # get :: Get (Hashed a) Source # putList :: [Hashed a] -> Put Source #
(Hashable v, Eq v, Binary v) => Binary (HashSet v) Source #
Instance details Defined in Data.Binary.Orphans Methods put :: HashSet v -> Put Source # get :: Get (HashSet v) Source # putList :: [HashSet v] -> Put Source #
(Binary a, Binary b) => Binary (Either a b)
Instance details Defined in Data.Binary.Class Methods put :: Either a b -> Put Source # get :: Get (Either a b) Source # putList :: [Either a b] -> Put Source #
Typeable a => Binary (TypeRep a)
Instance details Defined in Data.Binary.Class Methods put :: TypeRep a -> Put Source # get :: Get (TypeRep a) Source # putList :: [TypeRep a] -> Put Source #
(Binary a, Binary b) => Binary (a, b)
Instance details Defined in Data.Binary.Class Methods put :: (a, b) -> Put Source # get :: Get (a, b) Source # putList :: [(a, b)] -> Put Source #
(Hashable k, Eq k, Binary k, Binary v) => Binary (HashMap k v) Source #
Instance details Defined in Data.Binary.Orphans Methods put :: HashMap k v -> Put Source # get :: Get (HashMap k v) Source # putList :: [HashMap k v] -> Put Source #
(Binary k, Binary e) => Binary (Map k e)
Instance details Defined in Data.Binary.Class Methods put :: Map k e -> Put Source # get :: Get (Map k e) Source # putList :: [Map k e] -> Put Source #
(Binary i, Ix i, Binary e, IArray UArray e) => Binary (UArray i e)
Instance details Defined in Data.Binary.Class Methods put :: UArray i e -> Put Source # get :: Get (UArray i e) Source # putList :: [UArray i e] -> Put Source #
(Binary i, Ix i, Binary e) => Binary (Array i e)
Instance details Defined in Data.Binary.Class Methods put :: Array i e -> Put Source # get :: Get (Array i e) Source # putList :: [Array i e] -> Put Source #
(Binary a, Binary b) => Binary (Arg a b)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Arg a b -> Put Source # get :: Get (Arg a b) Source # putList :: [Arg a b] -> Put Source #
(Binary a, Binary b, Binary c) => Binary (a, b, c)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c) -> Put Source # get :: Get (a, b, c) Source # putList :: [(a, b, c)] -> Put Source #
Binary (f a) => Binary (Alt f a)	Since: 0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Alt f a -> Put Source # get :: Get (Alt f a) Source # putList :: [Alt f a] -> Put Source #
Binary b => Binary (Tagged s b) Source #
Instance details Defined in Data.Binary.Orphans Methods put :: Tagged s b -> Put Source # get :: Get (Tagged s b) Source # putList :: [Tagged s b] -> Put Source #
(Binary a, Binary b, Binary c, Binary d) => Binary (a, b, c, d)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d) -> Put Source # get :: Get (a, b, c, d) Source # putList :: [(a, b, c, d)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e) => Binary (a, b, c, d, e)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e) -> Put Source # get :: Get (a, b, c, d, e) Source # putList :: [(a, b, c, d, e)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f) => Binary (a, b, c, d, e, f)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f) -> Put Source # get :: Get (a, b, c, d, e, f) Source # putList :: [(a, b, c, d, e, f)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g) => Binary (a, b, c, d, e, f, g)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g) -> Put Source # get :: Get (a, b, c, d, e, f, g) Source # putList :: [(a, b, c, d, e, f, g)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h) => Binary (a, b, c, d, e, f, g, h)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h) -> Put Source # get :: Get (a, b, c, d, e, f, g, h) Source # putList :: [(a, b, c, d, e, f, g, h)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i) => Binary (a, b, c, d, e, f, g, h, i)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h, i) -> Put Source # get :: Get (a, b, c, d, e, f, g, h, i) Source # putList :: [(a, b, c, d, e, f, g, h, i)] -> Put Source #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i, Binary j) => Binary (a, b, c, d, e, f, g, h, i, j)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h, i, j) -> Put Source # get :: Get (a, b, c, d, e, f, g, h, i, j) Source # putList :: [(a, b, c, d, e, f, g, h, i, j)] -> Put Source #

Module re-export

module Data.Binary

Orphan instances

Binary UTCTime Source #
Instance details Methods put :: UTCTime -> Put Source # get :: Get UTCTime Source # putList :: [UTCTime] -> Put Source #
Binary Value Source #
Instance details Methods put :: Value -> Put Source # get :: Get Value Source # putList :: [Value] -> Put Source #
Binary ZonedTime Source #	Since: binary-orphans-0.1.8.0
Instance details Methods put :: ZonedTime -> Put Source # get :: Get ZonedTime Source # putList :: [ZonedTime] -> Put Source #
Binary LocalTime Source #
Instance details Methods put :: LocalTime -> Put Source # get :: Get LocalTime Source # putList :: [LocalTime] -> Put Source #
Binary TimeOfDay Source #
Instance details Methods put :: TimeOfDay -> Put Source # get :: Get TimeOfDay Source # putList :: [TimeOfDay] -> Put Source #
Binary TimeZone Source #
Instance details Methods put :: TimeZone -> Put Source # get :: Get TimeZone Source # putList :: [TimeZone] -> Put Source #
Binary UniversalTime Source #
Instance details Methods put :: UniversalTime -> Put Source # get :: Get UniversalTime Source # putList :: [UniversalTime] -> Put Source #
Binary SystemTime Source #	Since: binary-orphans-0.1.7.0
Instance details Methods put :: SystemTime -> Put Source # get :: Get SystemTime Source # putList :: [SystemTime] -> Put Source #
Binary NominalDiffTime Source #
Instance details Methods put :: NominalDiffTime -> Put Source # get :: Get NominalDiffTime Source # putList :: [NominalDiffTime] -> Put Source #
Binary AbsoluteTime Source #	Since: binary-orphans-0.1.4.0
Instance details Methods put :: AbsoluteTime -> Put Source # get :: Get AbsoluteTime Source # putList :: [AbsoluteTime] -> Put Source #
Binary DiffTime Source #
Instance details Methods put :: DiffTime -> Put Source # get :: Get DiffTime Source # putList :: [DiffTime] -> Put Source #
Binary Day Source #
Instance details Methods put :: Day -> Put Source # get :: Get Day Source # putList :: [Day] -> Put Source #
(FoldCase a, Binary a) => Binary (CI a) Source #	Since: binary-orphans-0.1.5.0
Instance details Methods put :: CI a -> Put Source # get :: Get (CI a) Source # putList :: [CI a] -> Put Source #
(Hashable a, Binary a) => Binary (Hashed a) Source #
Instance details Methods put :: Hashed a -> Put Source # get :: Get (Hashed a) Source # putList :: [Hashed a] -> Put Source #
(Hashable v, Eq v, Binary v) => Binary (HashSet v) Source #
Instance details Methods put :: HashSet v -> Put Source # get :: Get (HashSet v) Source # putList :: [HashSet v] -> Put Source #
(Hashable k, Eq k, Binary k, Binary v) => Binary (HashMap k v) Source #
Instance details Methods put :: HashMap k v -> Put Source # get :: Get (HashMap k v) Source # putList :: [HashMap k v] -> Put Source #
Binary b => Binary (Tagged s b) Source #
Instance details Methods put :: Tagged s b -> Put Source # get :: Get (Tagged s b) Source # putList :: [Tagged s b] -> Put Source #