BytePatch.Pretty.PatchRep

Documentation

class PatchRep a where

Type has a binary representation for using in patchscripts.

Patchscripts are parsed parameterized over the type to edit. That type needs to become a bytestring for eventual patch application. We're forced into newtypes and typeclasses by Aeson already, so this just enables us to define some important patch generation behaviour in one place. Similarly to Aeson, if you require custom behaviour for existing types (e.g. length-prefixed strings instead of C-style null terminated), define a newtype over it.

Some values may not have valid patch representations, for example if you're patching a 1-byte length-prefixed string and your string is too long (>255 encoded bytes). Thus, toPatchRep is failable.

Methods

toPatchRep :: a -> Either String ByteString

Instances

PatchRep ByteString

Bytestrings are copied as-is.

Defined in BytePatch.Pretty.PatchRep

Methods

toPatchRep :: ByteString -> Either String ByteString

PatchRep Text

Text is converted to UTF-8 bytes and null-terminated.

Defined in BytePatch.Pretty.PatchRep

Methods

toPatchRep :: Text -> Either String ByteString

PatchRep HexByteString

Defined in BytePatch.Pretty.HexByteString

Methods

toPatchRep :: HexByteString -> Either String ByteString

KnownNat n => PatchRep (PascalText n)

Defined in BytePatch.Pretty.PascalText

Methods

toPatchRep :: PascalText n -> Either String ByteString