Binrep.Get

Documentation

type Getter a = Parser String a

class Get a where

Methods

get :: Getter a

Parse from binary.

Instances

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 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 ~ MagicVals (TiffMagic end), ByteVals 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 ~ MagicVals a, ByteVals bs) => Get (Magic a)

Forces magic values to be individual bytes.

TODO improve show - maybe hexbytestring goes here? lol

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)

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

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

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 String (a, ByteString)