Bytezap

Documentation

type Poke# = Addr# -> State# RealWorld -> (# State# RealWorld, Addr# #)

TODO inner poke type

TODO can I change this to

Ptr Word8 -> IO (Ptr Word8)

without any performance loss? it's the same underneath newtypes and datas. Ptr is a data rather than a newtype, but IO is just a newtype.

I originally did this to beat ptr-poker, but idk. Now doubtful.

newtype Poke

Unboxed poke operation.

A newtype allows us a monoidal interface.

Constructors

Poke

Fields

• unPoke :: Poke#

  Write at an offset from an address and return the next offset.

  The returned offset must be after the argument offset.

  TODO I use that output order because it matches IO. Probs doesn't matter.

Instances

Monoid Poke

The empty Poke simply returns its arguments.

Defined in Bytezap

Methods

mempty :: Poke

mappend :: Poke -> Poke -> Poke

mconcat :: [Poke] -> Poke

Semigroup Poke

Sequence two Pokes left-to-right.

Defined in Bytezap

Methods

(<>) :: Poke -> Poke -> Poke

sconcat :: NonEmpty Poke -> Poke

stimes :: Integral b => b -> Poke -> Poke

Put Poke

Fairly useless because Poke doesn't have a BLen instance.

Defined in Binrep.Put.Bytezap

Methods

put :: Poke -> Poke

GenericFoldMap Poke

Defined in Binrep.Put.Bytezap

Associated Types

type GenericFoldMapC Poke a

Methods

genericFoldMapF :: GenericFoldMapC Poke a => a -> Poke

type GenericFoldMapC Poke a

Defined in Binrep.Put.Bytezap

type GenericFoldMapC Poke a = Put a

poke :: Poke# -> Poke

Construct a Poke.

runPoke :: Int -> Poke -> ByteString

Allocate a buffer of the given size and run a Poke over it.

The Poke must fill the buffer exactly. If it goes under, you should get some random garbage at the end. If it goes over, your computer will probably explode.

wrapPoke :: Poke -> Ptr Word8 -> IO ()

data Write

Instructions on how to perform a sized write.

The Poke in writePoke must write the _exact_ number of bytes specified in writeSize. Otherwise, your computer explodes.

Constructors

Write

Fields

• writeSize :: !Int
• writePoke :: !Poke

Instances

Monoid Write

The empty Write is the empty Poke, which writes zero bytes.

Defined in Bytezap

Methods

mempty :: Write

mappend :: Write -> Write -> Write

mconcat :: [Write] -> Write

Semigroup Write

Sequence the Pokes, sum the sizes.

Defined in Bytezap

Methods

(<>) :: Write -> Write -> Write

sconcat :: NonEmpty Write -> Write

stimes :: Integral b => b -> Write -> Write

Show Write

Serialize and show the resulting ByteString.

Defined in Bytezap

Methods

showsPrec :: Int -> Write -> ShowS

show :: Write -> String

showList :: [Write] -> ShowS

BLen Write

Defined in Binrep.BLen.Simple

Methods

blen :: Write -> Int

Get Write

Parse a bytestring and... immediate reserialize 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.Flatparse

Methods

get :: Getter Write

Put Write

Defined in Binrep.Put.Bytezap

Methods

put :: Write -> Poke

Put Write

Defined in Bytezap.Class

Methods

put :: Write -> Write

Get (Thin Write)

Defined in Binrep.Type.Thin

Methods

get :: Getter (Thin Write)

write :: Int -> Poke# -> Write

Construct a Write.

runWrite :: Write -> ByteString