Binrep.Get

Documentation

type Getter a = Parser E a

class Get a where

Methods

get :: Getter a

Parse from binary.

Instances

(TypeError ENoEmpty :: Constraint) => Get Void

Defined in Binrep.Get

Methods

get :: Getter Void

Get Int8

8-bit (1-byte) words do not require byte order in order to precisely define their representation.

Defined in Binrep.Get

Methods

get :: Getter Int8

Get Word8

8-bit (1-byte) words do not require byte order in order to precisely define their representation.

Defined in Binrep.Get

Methods

get :: Getter Word8

Get ByteString

Return the rest of the input.

A plain unannotated bytestring isn't very useful -- you'll usually want to null-terminate or length-prefix it.

Note that this _does_ perform work: we make a new bytestring so we don't rely on the input bytestring. To use the input bytestring directly, see Binrep.Type.Thin.

Defined in Binrep.Get

Methods

get :: Getter ByteString

Get ()

Unit type parses nothing.

Defined in Binrep.Get

Methods

get :: Getter ()

Get a => Get (Identity a)

Defined in Binrep.Get

Methods

get :: Getter (Identity a)

Prim' a => Get (ViaPrim a)

Defined in Binrep.Get

Methods

get :: Getter (ViaPrim a)

Get a => Get (NullTerminated a)

We may parse any null-terminated data using a special flatparse combinator.

Defined in Binrep.Type.NullTerminated

Methods

get :: Getter (NullTerminated a)

Get (Thin ByteString)

Defined in Binrep.Type.Thin

Methods

get :: Getter (Thin ByteString)

Get a => Get [a]

Parse elements until EOF. Sometimes used at the "top" of binary formats.

Defined in Binrep.Get

Methods

get :: Getter [a]

(TypeError ENoSum :: Constraint) => Get (Either a b)

Defined in Binrep.Get

Methods

get :: Getter (Either a b)

(bs ~ MagicBytes a, ReifyBytesW64 bs, KnownNat (Length bs)) => Get (Magic a)

Defined in Binrep.Type.Magic

Methods

get :: Getter (Magic a)

(Get a, KnownNat n) => Get (NullPadded n a)

Defined in Binrep.Type.NullPadded

Methods

get :: Getter (NullPadded n a)

(Prefix pfx, GetSize a, Get pfx) => Get (SizePrefixed pfx a)

Defined in Binrep.Type.Prefix.Size

Methods

get :: Getter (SizePrefixed pfx a)

(Get a, KnownNat n) => Get (Sized n a)

Defined in Binrep.Type.Sized

Methods

get :: Getter (Sized n a)

(Prim' a, ByteSwap a) => Get (ByteOrdered 'BigEndian a)

Defined in Binrep.Get

Methods

get :: Getter (ByteOrdered 'BigEndian a)

(Prim' a, ByteSwap a) => Get (ByteOrdered 'LittleEndian a)

Defined in Binrep.Get

Methods

get :: Getter (ByteOrdered 'LittleEndian a)

Get (ByteOrdered end Int8)

Byte order is irrelevant for 8-bit (1-byte) words.

Defined in Binrep.Get

Methods

get :: Getter (ByteOrdered end Int8)

Get (ByteOrdered end Word8)

Byte order is irrelevant for 8-bit (1-byte) words.

Defined in Binrep.Get

Methods

get :: Getter (ByteOrdered end Word8)

(Get l, Get r) => Get (l, r)

Parse tuples left-to-right.

Defined in Binrep.Get

Methods

get :: Getter (l, r)

GenericTraverse Get

Defined in Binrep.Get

Associated Types

type GenericTraverseF Get :: Type -> Type

type GenericTraverseC Get a

Methods

genericTraverseAction :: GenericTraverseC Get a => String -> String -> Maybe String -> Natural -> GenericTraverseF Get a

GenericTraverseSum Get

Defined in Binrep.Get

Methods

genericTraverseSumPfxTagAction :: GenericTraverseC Get pt => String -> GenericTraverseF Get pt

genericTraverseSumNoMatchingCstrAction :: String -> [String] -> Text -> GenericTraverseF Get a

(Prefix pfx, GetCount f, Get pfx, Get a) => Get (CountPrefixed pfx f a)

Defined in Binrep.Type.Prefix.Count

Methods

get :: Getter (CountPrefixed pfx f a)

type GenericTraverseF Get

Defined in Binrep.Get

type GenericTraverseF Get = Parser E

type GenericTraverseC Get a

Defined in Binrep.Get

type GenericTraverseC Get a = Get a

runGet :: Get a => ByteString -> Either E (a, ByteString)

runGetter :: Getter a -> ByteString -> Either E (a, ByteString)

data E

Structured parse error.

Constructors

E Int EMiddle

EFail

Unhandled parse error.

You get this if you don't change a flatparse fail to an error.

Should not be set except by library code.

Instances

Generic E

Defined in Binrep.Get

Associated Types

type Rep E :: Type -> Type

Methods

from :: E -> Rep E x

to :: Rep E x -> E

Show E

Defined in Binrep.Get

Methods

showsPrec :: Int -> E -> ShowS

show :: E -> String

showList :: [E] -> ShowS

Eq E

Defined in Binrep.Get

Methods

(==) :: E -> E -> Bool

(/=) :: E -> E -> Bool

type Rep E

Defined in Binrep.Get

type Rep E

data EBase

Constructors

EExpectedByte Word8 Word8

expected first, got second

EOverlong Int Int

expected first, got second

EExpected ByteString ByteString

expected first, got second

EFailNamed String

known fail

EFailParse String ByteString Word8

parse fail (where you parse a larger object, then a smaller one in it)

ERanOut Int

ran out of input, needed precisely n bytes for this part (n > 0)

Actually a Natural, but we use Int because that's what flatparse uses internally.

Instances

Generic EBase

Defined in Binrep.Get

Associated Types

type Rep EBase :: Type -> Type

Methods

from :: EBase -> Rep EBase x

to :: Rep EBase x -> EBase

Show EBase

Defined in Binrep.Get

Methods

showsPrec :: Int -> EBase -> ShowS

show :: EBase -> String

showList :: [EBase] -> ShowS

Eq EBase

Defined in Binrep.Get

Methods

(==) :: EBase -> EBase -> Bool

(/=) :: EBase -> EBase -> Bool

type Rep EBase

Defined in Binrep.Get

type Rep EBase = D1 ('MetaData "EBase" "Binrep.Get" "binrep-0.6.0-inplace" 'False) ((C1 ('MetaCons "EExpectedByte" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)) :+: (C1 ('MetaCons "EOverlong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "EExpected" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))) :+: (C1 ('MetaCons "EFailNamed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: (C1 ('MetaCons "EFailParse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8))) :+: C1 ('MetaCons "ERanOut" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

data EGeneric e

A generic context layer for a parse error of type e.

Recursive: parse errors occurring in fields are wrapped up here. (Those errors may also have a generic context layer.)

Making this explicitly recursive may seem strange, but it clarifies that this data type is to be seen as a layer over a top-level type.

Constructors

EGenericSum (EGenericSum e)

Parse error relating to sum types (constructors).

EGenericField

Parse error in a constructor field.

Fields

• String

  constructor name

• (Maybe String)

  field record name (if present)

• Natural

  field index in constructor

• e

  field parse error

Instances

Generic (EGeneric e)

Defined in Binrep.Get

Associated Types

type Rep (EGeneric e) :: Type -> Type

Methods

from :: EGeneric e -> Rep (EGeneric e) x

to :: Rep (EGeneric e) x -> EGeneric e

Show e => Show (EGeneric e)

Defined in Binrep.Get

Methods

showsPrec :: Int -> EGeneric e -> ShowS

show :: EGeneric e -> String

showList :: [EGeneric e] -> ShowS

Eq e => Eq (EGeneric e)

Defined in Binrep.Get

Methods

(==) :: EGeneric e -> EGeneric e -> Bool

(/=) :: EGeneric e -> EGeneric e -> Bool

type Rep (EGeneric e)

Defined in Binrep.Get

type Rep (EGeneric e) = D1 ('MetaData "EGeneric" "Binrep.Get" "binrep-0.6.0-inplace" 'False) (C1 ('MetaCons "EGenericSum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EGenericSum e))) :+: C1 ('MetaCons "EGenericField" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 e))))

data EGenericSum e

Constructors

EGenericSumTag e

Parse error parsing prefix tag.

EGenericSumTagNoMatch

Unable to match a constructor to the parsed prefix tag.

Fields

• [String]

  constructors tested

• Text

  prettified prefix tag

Instances

Generic (EGenericSum e)

Defined in Binrep.Get

Associated Types

type Rep (EGenericSum e) :: Type -> Type

Methods

from :: EGenericSum e -> Rep (EGenericSum e) x

to :: Rep (EGenericSum e) x -> EGenericSum e

Show e => Show (EGenericSum e)

Defined in Binrep.Get

Methods

showsPrec :: Int -> EGenericSum e -> ShowS

show :: EGenericSum e -> String

showList :: [EGenericSum e] -> ShowS

Eq e => Eq (EGenericSum e)

Defined in Binrep.Get

Methods

(==) :: EGenericSum e -> EGenericSum e -> Bool

(/=) :: EGenericSum e -> EGenericSum e -> Bool

type Rep (EGenericSum e)

Defined in Binrep.Get

type Rep (EGenericSum e) = D1 ('MetaData "EGenericSum" "Binrep.Get" "binrep-0.6.0-inplace" 'False) (C1 ('MetaCons "EGenericSumTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 e)) :+: C1 ('MetaCons "EGenericSumTagNoMatch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

eBase :: EBase -> Getter a

getEBase :: Getter a -> EBase -> Getter a

getPrim :: forall a. Prim' a => Getter a

Parse any Prim'.

getGenericNonSum :: forall a. (Generic a, GTraverseNonSum Get (Rep a), GAssertNotVoid a, GAssertNotSum a) => Getter a

getGenericSum :: forall pt a. (Generic a, GTraverseSum Get 'SumOnly (Rep a), Get pt, GAssertNotVoid a, GAssertSum a) => PfxTagCfg pt -> Getter a