Binrep.Get

Documentation

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 SumType

Defined in Binrep.Example.Sum

Methods

get :: Getter SumType

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 ()

(Generic a, GTraverseNonSum Get (Rep a), GAssertNotVoid a, GAssertNotSum a) => Get (GenericallyNonSum a)

Defined in Binrep.Get

Methods

get :: Getter (GenericallyNonSum a)

(Prim' a, Typeable a) => Get (ViaPrim a)

Defined in Binrep.Get

Methods

get :: Getter (ViaPrim a)

(GetC a, KnownNat (CBLen a)) => Get (ViaGetC a)

Defined in Binrep.Get

Methods

get :: Getter (ViaGetC a)

Get a => Get (NullTerminated a)

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

The combinator doesn't permit distinguishing between the two possible failures: either there was no next null, or the inner parser didn't consume up to it.

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, ParseReifyBytesW64 0 bs, 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)

(LenNat 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, Typeable a) => Get (ByteOrdered 'BigEndian a)

Defined in Binrep.Get

Methods

get :: Getter (ByteOrdered 'BigEndian a)

(Prim' a, ByteSwap a, Typeable 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)

(Num a, Ord a) => Get (Refined (AsciiNat 2) a)

Parse a binary (base 2) ASCII natural to any Num type.

Defined in Binrep.Type.AsciiNat

Methods

get :: Getter (Refined (AsciiNat 2) a)

(Num a, Ord a) => Get (Refined (AsciiNat 8) a)

Parse an octal (base 8) ASCII natural to any Num type.

Defined in Binrep.Type.AsciiNat

Methods

get :: Getter (Refined (AsciiNat 8) a)

(Num a, Ord a) => Get (Refined (AsciiNat 10) a)

Parse a decimal (base 10) ASCII natural to any Num type.

Defined in Binrep.Type.AsciiNat

Methods

get :: Getter (Refined (AsciiNat 10) a)

(Num a, Ord a) => Get (Refined (AsciiNat 16) a)

Parse a hex (base 16) ASCII natural to any Num type.

Parses lower and upper case (mixed permitted).

Defined in Binrep.Type.AsciiNat

Methods

get :: Getter (Refined (AsciiNat 16) a)

Get (Refined pr (Refined pl a)) => Get (Refined (And pl pr) a)

Defined in Binrep.Get

Methods

get :: Getter (Refined (And pl pr) a)

(LenNat 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)

runGet :: Get a => ByteString -> Either (ParseError Int Builder) (a, ByteString)

cutting1 :: forall (st :: ZeroBitType) text a. ParserT st (ParseError Pos text) a -> [text] -> ParserT st (ParseError Pos text) a

Turn a Fail into a single error, or prepend it to any existing ones.

Use when wrapping other getters.

We reimplement cutting with a tweak. Otherwise, we'd have to join lists in the error case (instead of simply prepending).

type Getter = Parser (ParseError Pos Builder)

runGetter :: Getter a -> ByteString -> Either (ParseError Int Builder) (a, ByteString)

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

getGenericSum :: forall {k} (sumtag :: k) pt a. (Generic a, GTraverseSum Get sumtag (Rep a), Get pt, GAssertNotVoid a, GAssertSum a) => ParseCstrTo sumtag pt -> (pt -> pt -> Bool) -> Getter a

err1 :: forall text (st :: ZeroBitType) a. [text] -> ParserT st (ParseError Pos text) a

Emit a single error. Use with flatparse primitives that only Fail.

getGenericSumRaw :: forall pt a. (Generic a, GTraverseSum Get Raw (Rep a), Get pt, GAssertNotVoid a, GAssertSum a) => (String -> pt) -> (pt -> pt -> Bool) -> Getter a

cut1 :: forall (st :: ZeroBitType) text a. ParserT st (ParseError Pos text) a -> [text] -> ParserT st (ParseError Pos text) a

Turn a Fail into a single error. (Re-emits existing Errors.)

Use when wrapping flatparse primitives that directly only Fail. (It's fine to use with combinators if the combinator itself doesn't Error.)

fpToBz :: forall (st :: ZeroBitType) text a r. ParserT st (ParseError Pos text) a -> Int# -> (a -> Int# -> ParserT st (ParseError Int text) r) -> ParserT st (ParseError Int text) r

newtype ViaGetC a

Constructors

ViaGetC

Fields

• unViaGetC :: a

Instances

(GetC a, KnownNat (CBLen a)) => Get (ViaGetC a)

Defined in Binrep.Get

Methods

get :: Getter (ViaGetC a)

bzToFp :: KnownNat (CBLen a) => GetterC a -> Getter a

getPrim :: (Prim' a, Typeable a) => Getter a

Parse any Prim'.

typeRep' :: forall {k} (a :: k). Typeable a => TypeRep

module Binrep.Get.Error