Binrep.Get

Documentation

type Getter a = Parser E a

class Get a where

Methods

get :: Getter a

Parse from binary.

Instances

Get Void

Impossible to parse Void.

Defined in Binrep.Get

Methods

get :: Getter Void

Get Int8

Defined in Binrep.Get

Methods

get :: Getter Int8

Get Word8

Defined in Binrep.Get

Methods

get :: Getter Word8

Get DCS

Defined in Binrep.Example

Methods

get :: Getter DCS

Get DSS

Defined in Binrep.Example

Methods

get :: Getter DSS

Get DU

Defined in Binrep.Example

Methods

get :: Getter DU

Get DX

Defined in Binrep.Example

Methods

get :: Getter DX

Get Tar

Defined in Binrep.Example.Tar

Methods

get :: Getter Tar

Get Tiff

Defined in Binrep.Example.Tiff

Methods

get :: Getter Tiff

Get WavHeader

Defined in Binrep.Example.Wav

Methods

get :: Getter WavHeader

Get ByteString

Defined in Binrep.Get

Methods

get :: Getter ByteString

(bs ~ MagicBytes (TiffMagic end), ReifyBytes bs, irep ~ I 'U 'I4 end, Get irep) => Get (TiffBody end)

Defined in Binrep.Example.Tiff

Methods

get :: Getter (TiffBody end)

Get (AsciiNat 8)

Defined in Binrep.Type.AsciiNat

Methods

get :: Getter (AsciiNat 8)

Get (AsByteString 'C)

Defined in Binrep.Type.ByteString

Methods

get :: Getter (AsByteString 'C)

(itype ~ I 'U size end, irep ~ IRep 'U size, Integral irep, Get itype) => Get (AsByteString ('Pascal size end))

Defined in Binrep.Type.ByteString

Methods

get :: Getter (AsByteString ('Pascal size end))

KnownSymbol str => Get (MagicUTF8 str)

Defined in Binrep.Type.Magic.UTF8

Methods

get :: Getter (MagicUTF8 str)

Get a => Get [a]

Parse heterogeneous lists in order. No length indicator, so either fails or succeeds by reaching EOF. Probably not what you usually want, but sometimes used at the "top" of binary formats.

Defined in Binrep.Get

Methods

get :: Getter [a]

Get a => Get (Table 'Strong a)

Defined in Binrep.Example.FileTable

Methods

get :: Getter (Table 'Strong a)

KnownNat n => Get (TarNat n)

Defined in Binrep.Example.Tar

Methods

get :: Getter (TarNat n)

(bs ~ MagicBytes a, ReifyBytes bs) => Get (Magic a)

Defined in Binrep.Type.Magic

Methods

get :: Getter (Magic a)

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

Safety: we assert actual length is within expected length (in order to calculate how much padding to parse).

Note that the consumer probably doesn't care about the content of the padding, just that the data is chunked correctly. I figure we care about correctness here, so it'd be nice to know about the padding well-formedness (i.e. that it's all nulls).

TODO maybe better definition via isolate

Defined in Binrep.Type.NullPadded

Methods

get :: Getter (NullPadded n a)

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

Defined in Binrep.Type.Sized

Methods

get :: Getter (Sized n a)

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

Defined in Binrep.Type.Vector

Methods

get :: Getter (Vector n a)

(Get a, Get b) => Get (a, b)

Defined in Binrep.Get

Methods

get :: Getter (a, b)

Get (I 'S 'I1 e)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I1 e)

Get (I 'S 'I2 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I2 'BE)

Get (I 'S 'I2 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I2 'LE)

Get (I 'S 'I4 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I4 'BE)

Get (I 'S 'I4 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I4 'LE)

Get (I 'S 'I8 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I8 'BE)

Get (I 'S 'I8 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'S 'I8 'LE)

Get (I 'U 'I1 e)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I1 e)

Get (I 'U 'I2 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I2 'BE)

Get (I 'U 'I2 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I2 'LE)

Get (I 'U 'I4 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I4 'BE)

Get (I 'U 'I4 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I4 'LE)

Get (I 'U 'I8 'BE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I8 'BE)

Get (I 'U 'I8 'LE)

Defined in Binrep.Type.Int

Methods

get :: Getter (I 'U 'I8 'LE)

(itype ~ I 'U size end, irep ~ IRep 'U size, Get itype, Integral irep, Get a, KnownNat (MaxBound irep)) => Get (LenPfx size end a)

Defined in Binrep.Type.LenPfx

Methods

get :: Getter (LenPfx size end a)

(VarintContinuation cont, Integral i, Bits i) => Get (Varnat 'Bijective cont 'BE i)

TODO nothing to test against - unsure if correct

Defined in Binrep.Type.Varint

Methods

get :: Getter (Varnat 'Bijective cont 'BE i)

(VarintContinuation cont, Integral i, Bits i) => Get (Varnat 'Bijective cont 'LE i)

Git varint (cont=on), BPS (beat patches) (cont=off)

Defined in Binrep.Type.Varint

Methods

get :: Getter (Varnat 'Bijective cont 'LE i)

(VarintContinuation cont, Integral i, Bits i) => Get (Varnat 'Redundant cont 'BE i)

VLQ (cont=on)

Defined in Binrep.Type.Varint

Methods

get :: Getter (Varnat 'Redundant cont 'BE i)

(VarintContinuation cont, Integral i, Bits i) => Get (Varnat 'Redundant cont 'LE i)

protobuf (cont=on), LEB128 (cont=on)

not truly infinite length since shifters take Int, but practically infinite

Defined in Binrep.Type.Varint

Methods

get :: Getter (Varnat 'Redundant cont 'LE i)

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

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

data E

Constructors

EBase EBase

EGeneric

Fields

• String

  datatype name

• EGeneric

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 = D1 ('MetaData "E" "Binrep.Get" "binrep-0.3.1-inplace" 'False) (C1 ('MetaCons "EBase" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EBase)) :+: C1 ('MetaCons "EGeneric" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EGeneric)))

data EBase

Constructors

ENoVoid

EFail

EExpectedByte Word8 Word8

expected first, got second

EOverlong BLenT BLenT

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 Natural

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

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.3.1-inplace" 'False) (((C1 ('MetaCons "ENoVoid" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EFail" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (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 BLenT) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BLenT)))) :+: ((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 Natural)))))

data EGeneric

Constructors

EGenericSum EGenericSum

EGenericField String (Maybe String) Natural E

Instances

Generic EGeneric

Defined in Binrep.Get

Associated Types

type Rep EGeneric :: Type -> Type

Methods

from :: EGeneric -> Rep EGeneric x

to :: Rep EGeneric x -> EGeneric

Show EGeneric

Defined in Binrep.Get

Methods

showsPrec :: Int -> EGeneric -> ShowS

show :: EGeneric -> String

showList :: [EGeneric] -> ShowS

Eq EGeneric

Defined in Binrep.Get

Methods

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

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

type Rep EGeneric

Defined in Binrep.Get

type Rep EGeneric = D1 ('MetaData "EGeneric" "Binrep.Get" "binrep-0.3.1-inplace" 'False) (C1 ('MetaCons "EGenericSum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EGenericSum)) :+: 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

Constructors

EGenericSumTag E

EGenericSumTagNoMatch [String] Text

Instances

Generic EGenericSum

Defined in Binrep.Get

Associated Types

type Rep EGenericSum :: Type -> Type

Methods

from :: EGenericSum -> Rep EGenericSum x

to :: Rep EGenericSum x -> EGenericSum

Show EGenericSum

Defined in Binrep.Get

Methods

showsPrec :: Int -> EGenericSum -> ShowS

show :: EGenericSum -> String

showList :: [EGenericSum] -> ShowS

Eq EGenericSum

Defined in Binrep.Get

Methods

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

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

type Rep EGenericSum

Defined in Binrep.Get

type Rep EGenericSum = D1 ('MetaData "EGenericSum" "Binrep.Get" "binrep-0.3.1-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

getEWrap :: Get a => (E -> E) -> Getter a

TODO confirm correct operation (error combination)

getEBase :: Get a => EBase -> Getter a

cutEBase :: Getter a -> EBase -> Getter a

class GetWith (r :: TYPE rep) a | a -> r where

A type that can be parsed from binary given some environment.

Making this levity polymorphic makes things pretty strange, but is useful. See Binrep.Example.FileTable.

Methods

getWith :: r -> Getter a

Parse from binary with the given environment.

Instances

Get a => GetWith Addr# (Entry 'Strong a)

Defined in Binrep.Example.FileTable

Methods

getWith :: Addr# -> Getter (Entry 'Strong a)

runGetWith :: GetWith (r :: TYPE LiftedRep) a => r -> ByteString -> Either E (a, ByteString)