Safe Haskell	Safe
Language	Haskell2010

Data.Binary.Combinators

Description

This module defines a bunch of types to be used as fields of records with Generic-based deriving of Binary instances. For example:

data MyFileFormat = MyFileFormat
  { header :: MatchBytes "my format header" '[ 0xd3, 0x4d, 0xf0, 0x0d ]
  , slack :: SkipByte 0xff
  , reserved :: SkipCount Word8 4
  , subElements :: Some MyElement
  } deriving (Generic, Binary)

Synopsis

newtype Many a = Many {
- getMany :: [a]
}
newtype Some a = Some {
- getSome :: [a]
}
newtype CountedBy (ty :: k) a = CountedBy {
- getCounted :: [a]
}
data SkipCount (ty :: k) (n :: Nat) = SkipCount
data SkipByte (n :: Nat) = SkipByte
data MatchBytes (ctx :: Symbol) (bytes :: [Nat])
matchBytes :: forall (ctx :: Symbol) (ns :: [Nat]). MatchBytesSing ctx ns => MatchBytes ctx ns
type MatchByte (ctx :: Symbol) (byte :: Nat) = MatchBytes ctx '[byte]
data MatchASCII (ctx :: Symbol) (ascii :: Symbol)
matchASCII :: forall (ctx :: Symbol) (ascii :: Symbol). (KnownSymbol ctx, KnownSymbol ascii) => MatchASCII ctx ascii
newtype LE a = LE {
- getLE :: a
}

Documentation

newtype Many a Source #

Zero or more elements of a, parsing as long as the parser for a succeeds.

Many Word8 will consume all your input!

Constructors

Many
Fields getMany :: [a]

Instances

Instances details

Functor Many Source #
Instance details Defined in Data.Binary.Combinators Methods fmap :: (a -> b) -> Many a -> Many b # (<$) :: a -> Many b -> Many a #
Foldable Many Source #
Instance details Defined in Data.Binary.Combinators Methods fold :: Monoid m => Many m -> m # foldMap :: Monoid m => (a -> m) -> Many a -> m # foldMap' :: Monoid m => (a -> m) -> Many a -> m # foldr :: (a -> b -> b) -> b -> Many a -> b # foldr' :: (a -> b -> b) -> b -> Many a -> b # foldl :: (b -> a -> b) -> b -> Many a -> b # foldl' :: (b -> a -> b) -> b -> Many a -> b # foldr1 :: (a -> a -> a) -> Many a -> a # foldl1 :: (a -> a -> a) -> Many a -> a # toList :: Many a -> [a] # null :: Many a -> Bool # length :: Many a -> Int # elem :: Eq a => a -> Many a -> Bool # maximum :: Ord a => Many a -> a # minimum :: Ord a => Many a -> a # sum :: Num a => Many a -> a # product :: Num a => Many a -> a #
Traversable Many Source #
Instance details Defined in Data.Binary.Combinators Methods traverse :: Applicative f => (a -> f b) -> Many a -> f (Many b) # sequenceA :: Applicative f => Many (f a) -> f (Many a) # mapM :: Monad m => (a -> m b) -> Many a -> m (Many b) # sequence :: Monad m => Many (m a) -> m (Many a) #
Arbitrary a => Arbitrary (Many a) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (Many a) # shrink :: Many a -> [Many a] #
Binary a => Binary (Many a) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: Many a -> Put # get :: Get (Many a) # putList :: [Many a] -> Put #
Show a => Show (Many a) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> Many a -> ShowS # show :: Many a -> String # showList :: [Many a] -> ShowS #
Eq a => Eq (Many a) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: Many a -> Many a -> Bool # (/=) :: Many a -> Many a -> Bool #
Ord a => Ord (Many a) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: Many a -> Many a -> Ordering # (<) :: Many a -> Many a -> Bool # (<=) :: Many a -> Many a -> Bool # (>) :: Many a -> Many a -> Bool # (>=) :: Many a -> Many a -> Bool # max :: Many a -> Many a -> Many a # min :: Many a -> Many a -> Many a #

newtype Some a Source #

One or more elements of a, parsing as long as the parser for a succeeds.

Some Word8 will consume all your non-empty input!

Constructors

Some
Fields getSome :: [a]

Instances

Instances details

Functor Some Source #
Instance details Defined in Data.Binary.Combinators Methods fmap :: (a -> b) -> Some a -> Some b # (<$) :: a -> Some b -> Some a #
Foldable Some Source #
Instance details Defined in Data.Binary.Combinators Methods fold :: Monoid m => Some m -> m # foldMap :: Monoid m => (a -> m) -> Some a -> m # foldMap' :: Monoid m => (a -> m) -> Some a -> m # foldr :: (a -> b -> b) -> b -> Some a -> b # foldr' :: (a -> b -> b) -> b -> Some a -> b # foldl :: (b -> a -> b) -> b -> Some a -> b # foldl' :: (b -> a -> b) -> b -> Some a -> b # foldr1 :: (a -> a -> a) -> Some a -> a # foldl1 :: (a -> a -> a) -> Some a -> a # toList :: Some a -> [a] # null :: Some a -> Bool # length :: Some a -> Int # elem :: Eq a => a -> Some a -> Bool # maximum :: Ord a => Some a -> a # minimum :: Ord a => Some a -> a # sum :: Num a => Some a -> a # product :: Num a => Some a -> a #
Traversable Some Source #
Instance details Defined in Data.Binary.Combinators Methods traverse :: Applicative f => (a -> f b) -> Some a -> f (Some b) # sequenceA :: Applicative f => Some (f a) -> f (Some a) # mapM :: Monad m => (a -> m b) -> Some a -> m (Some b) # sequence :: Monad m => Some (m a) -> m (Some a) #
Arbitrary a => Arbitrary (Some a) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (Some a) # shrink :: Some a -> [Some a] #
Binary a => Binary (Some a) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: Some a -> Put # get :: Get (Some a) # putList :: [Some a] -> Put #
Show a => Show (Some a) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> Some a -> ShowS # show :: Some a -> String # showList :: [Some a] -> ShowS #
Eq a => Eq (Some a) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: Some a -> Some a -> Bool # (/=) :: Some a -> Some a -> Bool #
Ord a => Ord (Some a) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: Some a -> Some a -> Ordering # (<) :: Some a -> Some a -> Bool # (<=) :: Some a -> Some a -> Bool # (>) :: Some a -> Some a -> Bool # (>=) :: Some a -> Some a -> Bool # max :: Some a -> Some a -> Some a # min :: Some a -> Some a -> Some a #

newtype CountedBy (ty :: k) a Source #

First, parse the elements count as type ty. Then, parse exactly as many elements of type a.

Constructors

CountedBy
Fields getCounted :: [a]

Instances

Instances details

Functor (CountedBy ty) Source #
Instance details Defined in Data.Binary.Combinators Methods fmap :: (a -> b) -> CountedBy ty a -> CountedBy ty b # (<$) :: a -> CountedBy ty b -> CountedBy ty a #
Foldable (CountedBy ty) Source #
Instance details Defined in Data.Binary.Combinators Methods fold :: Monoid m => CountedBy ty m -> m # foldMap :: Monoid m => (a -> m) -> CountedBy ty a -> m # foldMap' :: Monoid m => (a -> m) -> CountedBy ty a -> m # foldr :: (a -> b -> b) -> b -> CountedBy ty a -> b # foldr' :: (a -> b -> b) -> b -> CountedBy ty a -> b # foldl :: (b -> a -> b) -> b -> CountedBy ty a -> b # foldl' :: (b -> a -> b) -> b -> CountedBy ty a -> b # foldr1 :: (a -> a -> a) -> CountedBy ty a -> a # foldl1 :: (a -> a -> a) -> CountedBy ty a -> a # toList :: CountedBy ty a -> [a] # null :: CountedBy ty a -> Bool # length :: CountedBy ty a -> Int # elem :: Eq a => a -> CountedBy ty a -> Bool # maximum :: Ord a => CountedBy ty a -> a # minimum :: Ord a => CountedBy ty a -> a # sum :: Num a => CountedBy ty a -> a # product :: Num a => CountedBy ty a -> a #
Traversable (CountedBy ty) Source #
Instance details Defined in Data.Binary.Combinators Methods traverse :: Applicative f => (a -> f b) -> CountedBy ty a -> f (CountedBy ty b) # sequenceA :: Applicative f => CountedBy ty (f a) -> f (CountedBy ty a) # mapM :: Monad m => (a -> m b) -> CountedBy ty a -> m (CountedBy ty b) # sequence :: Monad m => CountedBy ty (m a) -> m (CountedBy ty a) #
Arbitrary a => Arbitrary (CountedBy ty a) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (CountedBy ty a) # shrink :: CountedBy ty a -> [CountedBy ty a] #
(Integral ty, Binary ty, Binary a) => Binary (CountedBy ty a) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: CountedBy ty a -> Put # get :: Get (CountedBy ty a) # putList :: [CountedBy ty a] -> Put #
Show a => Show (CountedBy ty a) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> CountedBy ty a -> ShowS # show :: CountedBy ty a -> String # showList :: [CountedBy ty a] -> ShowS #
Eq a => Eq (CountedBy ty a) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: CountedBy ty a -> CountedBy ty a -> Bool # (/=) :: CountedBy ty a -> CountedBy ty a -> Bool #
Ord a => Ord (CountedBy ty a) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: CountedBy ty a -> CountedBy ty a -> Ordering # (<) :: CountedBy ty a -> CountedBy ty a -> Bool # (<=) :: CountedBy ty a -> CountedBy ty a -> Bool # (>) :: CountedBy ty a -> CountedBy ty a -> Bool # (>=) :: CountedBy ty a -> CountedBy ty a -> Bool # max :: CountedBy ty a -> CountedBy ty a -> CountedBy ty a # min :: CountedBy ty a -> CountedBy ty a -> CountedBy ty a #

data SkipCount (ty :: k) (n :: Nat) Source #

Parse out and skip n elements of type ty.

Serializing this type produces no bytes.

Constructors

SkipCount

Instances

Instances details

Arbitrary (SkipCount ty n) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (SkipCount ty n) # shrink :: SkipCount ty n -> [SkipCount ty n] #
(Num ty, Binary ty, KnownNat n) => Binary (SkipCount ty n) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: SkipCount ty n -> Put # get :: Get (SkipCount ty n) # putList :: [SkipCount ty n] -> Put #
Show (SkipCount ty n) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> SkipCount ty n -> ShowS # show :: SkipCount ty n -> String # showList :: [SkipCount ty n] -> ShowS #
Eq (SkipCount ty n) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: SkipCount ty n -> SkipCount ty n -> Bool # (/=) :: SkipCount ty n -> SkipCount ty n -> Bool #
Ord (SkipCount ty n) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: SkipCount ty n -> SkipCount ty n -> Ordering # (<) :: SkipCount ty n -> SkipCount ty n -> Bool # (<=) :: SkipCount ty n -> SkipCount ty n -> Bool # (>) :: SkipCount ty n -> SkipCount ty n -> Bool # (>=) :: SkipCount ty n -> SkipCount ty n -> Bool # max :: SkipCount ty n -> SkipCount ty n -> SkipCount ty n # min :: SkipCount ty n -> SkipCount ty n -> SkipCount ty n #

data SkipByte (n :: Nat) Source #

Skip any number of bytes with value n.

Serializing this type produces no bytes.

Constructors

SkipByte

Instances

Instances details

Arbitrary (SkipByte n) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (SkipByte n) # shrink :: SkipByte n -> [SkipByte n] #
KnownNat n => Binary (SkipByte n) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: SkipByte n -> Put # get :: Get (SkipByte n) # putList :: [SkipByte n] -> Put #
Show (SkipByte n) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> SkipByte n -> ShowS # show :: SkipByte n -> String # showList :: [SkipByte n] -> ShowS #
Eq (SkipByte n) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: SkipByte n -> SkipByte n -> Bool # (/=) :: SkipByte n -> SkipByte n -> Bool #
Ord (SkipByte n) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: SkipByte n -> SkipByte n -> Ordering # (<) :: SkipByte n -> SkipByte n -> Bool # (<=) :: SkipByte n -> SkipByte n -> Bool # (>) :: SkipByte n -> SkipByte n -> Bool # (>=) :: SkipByte n -> SkipByte n -> Bool # max :: SkipByte n -> SkipByte n -> SkipByte n # min :: SkipByte n -> SkipByte n -> SkipByte n #

data MatchBytes (ctx :: Symbol) (bytes :: [Nat]) Source #

MatchBytes str bytes ensures that the subsequent bytes in the input stream are the same as bytes.

str can be used to denote the context in which MatchBytes is used for better parse failure messages. For example, MatchBytes "my format header" '[ 0xd3, 0x4d, 0xf0, 0x0d ] consumes four bytes from the input stream if they are equal to [ 0xd3, 0x4d, 0xf0, 0x0d ] respectively, or fails otherwise.

Serializing this type produces the bytes. To easily create a value of this type, use the matchBytes helper.

Instances

Instances details

MatchBytesSing ctx ns => Arbitrary (MatchBytes ctx ns) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (MatchBytes ctx ns) # shrink :: MatchBytes ctx ns -> [MatchBytes ctx ns] #
(KnownSymbol ctx, KnownNat n, Binary (MatchBytes ctx ns)) => Binary (MatchBytes ctx (n ': ns)) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: MatchBytes ctx (n ': ns) -> Put # get :: Get (MatchBytes ctx (n ': ns)) # putList :: [MatchBytes ctx (n ': ns)] -> Put #
Binary (MatchBytes ctx ('[] :: [Nat])) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: MatchBytes ctx ('[] :: [Nat]) -> Put # get :: Get (MatchBytes ctx ('[] :: [Nat])) # putList :: [MatchBytes ctx ('[] :: [Nat])] -> Put #
Show (MatchBytes ctx ns) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> MatchBytes ctx ns -> ShowS # show :: MatchBytes ctx ns -> String # showList :: [MatchBytes ctx ns] -> ShowS #
Eq (MatchBytes s ns) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: MatchBytes s ns -> MatchBytes s ns -> Bool # (/=) :: MatchBytes s ns -> MatchBytes s ns -> Bool #
Ord (MatchBytes s ns) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: MatchBytes s ns -> MatchBytes s ns -> Ordering # (<) :: MatchBytes s ns -> MatchBytes s ns -> Bool # (<=) :: MatchBytes s ns -> MatchBytes s ns -> Bool # (>) :: MatchBytes s ns -> MatchBytes s ns -> Bool # (>=) :: MatchBytes s ns -> MatchBytes s ns -> Bool # max :: MatchBytes s ns -> MatchBytes s ns -> MatchBytes s ns # min :: MatchBytes s ns -> MatchBytes s ns -> MatchBytes s ns #

matchBytes :: forall (ctx :: Symbol) (ns :: [Nat]). MatchBytesSing ctx ns => MatchBytes ctx ns Source #

Produce the (singleton) value of type MatchBytes ctx ns.

type MatchByte (ctx :: Symbol) (byte :: Nat) = MatchBytes ctx '[byte] Source #

An alias for MatchBytes when you only need to match a single byte.

data MatchASCII (ctx :: Symbol) (ascii :: Symbol) Source #

MatchASCII ctx ascii ensures that the subsequent bytes in the input stream match the ASCII characters ascii.

Serializing this type producers the ascii. To easily create a value of this type, use the matchASCII helper.

Instances

Instances details

(KnownSymbol ctx, KnownSymbol ascii) => Arbitrary (MatchASCII ctx ascii) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (MatchASCII ctx ascii) # shrink :: MatchASCII ctx ascii -> [MatchASCII ctx ascii] #
(KnownSymbol ctx, KnownSymbol ascii) => Binary (MatchASCII ctx ascii) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: MatchASCII ctx ascii -> Put # get :: Get (MatchASCII ctx ascii) # putList :: [MatchASCII ctx ascii] -> Put #
Show (MatchASCII ctx ascii) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> MatchASCII ctx ascii -> ShowS # show :: MatchASCII ctx ascii -> String # showList :: [MatchASCII ctx ascii] -> ShowS #
Eq (MatchASCII s ns) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: MatchASCII s ns -> MatchASCII s ns -> Bool # (/=) :: MatchASCII s ns -> MatchASCII s ns -> Bool #
Ord (MatchASCII s ns) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: MatchASCII s ns -> MatchASCII s ns -> Ordering # (<) :: MatchASCII s ns -> MatchASCII s ns -> Bool # (<=) :: MatchASCII s ns -> MatchASCII s ns -> Bool # (>) :: MatchASCII s ns -> MatchASCII s ns -> Bool # (>=) :: MatchASCII s ns -> MatchASCII s ns -> Bool # max :: MatchASCII s ns -> MatchASCII s ns -> MatchASCII s ns # min :: MatchASCII s ns -> MatchASCII s ns -> MatchASCII s ns #

matchASCII :: forall (ctx :: Symbol) (ascii :: Symbol). (KnownSymbol ctx, KnownSymbol ascii) => MatchASCII ctx ascii Source #

Produce the (singleton) value of type MatchASCII ctx ascii.

newtype LE a Source #

An a serialized in little endian byte order.

By default, Binary serializes things in big endian byte order. Use this wrapper to get little endian-based serialization.

Constructors

LE
Fields getLE :: a

Instances

Instances details

Arbitrary a => Arbitrary (LE a) Source #
Instance details Defined in Data.Binary.Combinators Methods arbitrary :: Gen (LE a) # shrink :: LE a -> [LE a] #
Binary (LE Int16) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Int16 -> Put # get :: Get (LE Int16) # putList :: [LE Int16] -> Put #
Binary (LE Int32) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Int32 -> Put # get :: Get (LE Int32) # putList :: [LE Int32] -> Put #
Binary (LE Int64) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Int64 -> Put # get :: Get (LE Int64) # putList :: [LE Int64] -> Put #
Binary (LE Word16) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Word16 -> Put # get :: Get (LE Word16) # putList :: [LE Word16] -> Put #
Binary (LE Word32) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Word32 -> Put # get :: Get (LE Word32) # putList :: [LE Word32] -> Put #
Binary (LE Word64) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Word64 -> Put # get :: Get (LE Word64) # putList :: [LE Word64] -> Put #
Binary (LE Double) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Double -> Put # get :: Get (LE Double) # putList :: [LE Double] -> Put #
Binary (LE Float) Source #
Instance details Defined in Data.Binary.Combinators Methods put :: LE Float -> Put # get :: Get (LE Float) # putList :: [LE Float] -> Put #
Show a => Show (LE a) Source #
Instance details Defined in Data.Binary.Combinators Methods showsPrec :: Int -> LE a -> ShowS # show :: LE a -> String # showList :: [LE a] -> ShowS #
Eq a => Eq (LE a) Source #
Instance details Defined in Data.Binary.Combinators Methods (==) :: LE a -> LE a -> Bool # (/=) :: LE a -> LE a -> Bool #
Ord a => Ord (LE a) Source #
Instance details Defined in Data.Binary.Combinators Methods compare :: LE a -> LE a -> Ordering # (<) :: LE a -> LE a -> Bool # (<=) :: LE a -> LE a -> Bool # (>) :: LE a -> LE a -> Bool # (>=) :: LE a -> LE a -> Bool # max :: LE a -> LE a -> LE a # min :: LE a -> LE a -> LE a #