StreamPatch.Patch.Binary

Documentation

data Meta

Constructors

Meta

Fields

• mMaxBytes :: Maybe (SeekRep 'FwdSeek)

  Maximum number of bytes permitted to write at the associated position.

Instances

Eq Meta

Defined in StreamPatch.Patch.Binary

Methods

(==) :: Meta -> Meta -> Bool

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

Show Meta

Defined in StreamPatch.Patch.Binary

Methods

showsPrec :: Int -> Meta -> ShowS

show :: Meta -> String

showList :: [Meta] -> ShowS

Generic Meta

Defined in StreamPatch.Patch.Binary

Associated Types

type Rep Meta :: Type -> Type

Methods

from :: Meta -> Rep Meta x

to :: Rep Meta x -> Meta

type Rep Meta

Defined in StreamPatch.Patch.Binary

type Rep Meta = D1 ('MetaData "Meta" "StreamPatch.Patch.Binary" "bytepatch-0.3.1-inplace" 'False) (C1 ('MetaCons "Meta" 'PrefixI 'True) (S1 ('MetaSel ('Just "mMaxBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (SeekRep 'FwdSeek)))))

data MetaStream a

Constructors

MetaStream

Fields

• msNullTerminates :: Maybe (SeekRep 'FwdSeek)

  Stream segment should be null bytes (0x00) only from this index onwards.

• msExpected :: Maybe a

  Stream segment should be this.

Instances

Functor MetaStream

Defined in StreamPatch.Patch.Binary

Methods

fmap :: (a -> b) -> MetaStream a -> MetaStream b

(<$) :: a -> MetaStream b -> MetaStream a

Foldable MetaStream

Defined in StreamPatch.Patch.Binary

Methods

fold :: Monoid m => MetaStream m -> m

foldMap :: Monoid m => (a -> m) -> MetaStream a -> m

foldMap' :: Monoid m => (a -> m) -> MetaStream a -> m

foldr :: (a -> b -> b) -> b -> MetaStream a -> b

foldr' :: (a -> b -> b) -> b -> MetaStream a -> b

foldl :: (b -> a -> b) -> b -> MetaStream a -> b

foldl' :: (b -> a -> b) -> b -> MetaStream a -> b

foldr1 :: (a -> a -> a) -> MetaStream a -> a

foldl1 :: (a -> a -> a) -> MetaStream a -> a

toList :: MetaStream a -> [a]

null :: MetaStream a -> Bool

length :: MetaStream a -> Int

elem :: Eq a => a -> MetaStream a -> Bool

maximum :: Ord a => MetaStream a -> a

minimum :: Ord a => MetaStream a -> a

sum :: Num a => MetaStream a -> a

product :: Num a => MetaStream a -> a

Traversable MetaStream

Defined in StreamPatch.Patch.Binary

Methods

traverse :: Applicative f => (a -> f b) -> MetaStream a -> f (MetaStream b)

sequenceA :: Applicative f => MetaStream (f a) -> f (MetaStream a)

mapM :: Monad m => (a -> m b) -> MetaStream a -> m (MetaStream b)

sequence :: Monad m => MetaStream (m a) -> m (MetaStream a)

Eq a => Eq (MetaStream a)

Defined in StreamPatch.Patch.Binary

Methods

(==) :: MetaStream a -> MetaStream a -> Bool

(/=) :: MetaStream a -> MetaStream a -> Bool

Show a => Show (MetaStream a)

Defined in StreamPatch.Patch.Binary

Methods

showsPrec :: Int -> MetaStream a -> ShowS

show :: MetaStream a -> String

showList :: [MetaStream a] -> ShowS

Generic (MetaStream a)

Defined in StreamPatch.Patch.Binary

Associated Types

type Rep (MetaStream a) :: Type -> Type

Methods

from :: MetaStream a -> Rep (MetaStream a) x

to :: Rep (MetaStream a) x -> MetaStream a

type Rep (MetaStream a)

Defined in StreamPatch.Patch.Binary

type Rep (MetaStream a) = D1 ('MetaData "MetaStream" "StreamPatch.Patch.Binary" "bytepatch-0.3.1-inplace" 'False) (C1 ('MetaCons "MetaStream" 'PrefixI 'True) (S1 ('MetaSel ('Just "msNullTerminates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (SeekRep 'FwdSeek))) :*: S1 ('MetaSel ('Just "msExpected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))))

data Cfg

Constructors

Cfg

Fields

• cfgAllowPartialExpected :: Bool

  If enabled, allow partial expected bytes checking. If disabled, then even if the expected bytes are a prefix of the actual, fail.

Instances

Eq Cfg

Defined in StreamPatch.Patch.Binary

Methods

(==) :: Cfg -> Cfg -> Bool

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

Show Cfg

Defined in StreamPatch.Patch.Binary

Methods

showsPrec :: Int -> Cfg -> ShowS

show :: Cfg -> String

showList :: [Cfg] -> ShowS

Generic Cfg

Defined in StreamPatch.Patch.Binary

Associated Types

type Rep Cfg :: Type -> Type

Methods

from :: Cfg -> Rep Cfg x

to :: Rep Cfg x -> Cfg

type Rep Cfg

Defined in StreamPatch.Patch.Binary

type Rep Cfg = D1 ('MetaData "Cfg" "StreamPatch.Patch.Binary" "bytepatch-0.3.1-inplace" 'False) (C1 ('MetaCons "Cfg" 'PrefixI 'True) (S1 ('MetaSel ('Just "cfgAllowPartialExpected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

data Error a

Constructors

ErrorBadBinRep a String

ErrorUnexpectedNonNull ByteString

ErrorDidNotMatchExpected ByteString ByteString

ErrorBinRepTooLong ByteString Natural

Instances

Functor Error

Defined in StreamPatch.Patch.Binary

Methods

fmap :: (a -> b) -> Error a -> Error b

(<$) :: a -> Error b -> Error a

Foldable Error

Defined in StreamPatch.Patch.Binary

Methods

fold :: Monoid m => Error m -> m

foldMap :: Monoid m => (a -> m) -> Error a -> m

foldMap' :: Monoid m => (a -> m) -> Error a -> m

foldr :: (a -> b -> b) -> b -> Error a -> b

foldr' :: (a -> b -> b) -> b -> Error a -> b

foldl :: (b -> a -> b) -> b -> Error a -> b

foldl' :: (b -> a -> b) -> b -> Error a -> b

foldr1 :: (a -> a -> a) -> Error a -> a

foldl1 :: (a -> a -> a) -> Error a -> a

toList :: Error a -> [a]

null :: Error a -> Bool

length :: Error a -> Int

elem :: Eq a => a -> Error a -> Bool

maximum :: Ord a => Error a -> a

minimum :: Ord a => Error a -> a

sum :: Num a => Error a -> a

product :: Num a => Error a -> a

Traversable Error

Defined in StreamPatch.Patch.Binary

Methods

traverse :: Applicative f => (a -> f b) -> Error a -> f (Error b)

sequenceA :: Applicative f => Error (f a) -> f (Error a)

mapM :: Monad m => (a -> m b) -> Error a -> m (Error b)

sequence :: Monad m => Error (m a) -> m (Error a)

Eq a => Eq (Error a)

Defined in StreamPatch.Patch.Binary

Methods

(==) :: Error a -> Error a -> Bool

(/=) :: Error a -> Error a -> Bool

Show a => Show (Error a)

Defined in StreamPatch.Patch.Binary

Methods

showsPrec :: Int -> Error a -> ShowS

show :: Error a -> String

showList :: [Error a] -> ShowS

Generic (Error a)

Defined in StreamPatch.Patch.Binary

Associated Types

type Rep (Error a) :: Type -> Type

Methods

from :: Error a -> Rep (Error a) x

to :: Rep (Error a) x -> Error a

type Rep (Error a)

Defined in StreamPatch.Patch.Binary

type Rep (Error a) = D1 ('MetaData "Error" "StreamPatch.Patch.Binary" "bytepatch-0.3.1-inplace" 'False) ((C1 ('MetaCons "ErrorBadBinRep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "ErrorUnexpectedNonNull" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))) :+: (C1 ('MetaCons "ErrorDidNotMatchExpected" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "ErrorBinRepTooLong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))))

patchBinRep :: forall a s ss rs is i r. (BinRep a, Traversable (FunctorRec rs), r ~ Const Meta, rs ~ RDelete r ss, RElem r ss i, RSubset rs ss is) => Patch s ss a -> Either (Error a) (Patch s rs ByteString)

class BinRep 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

toBinRep :: a -> Either String ByteString

Instances

BinRep String

String is the same but goes the long way round, through Text.

Defined in StreamPatch.Patch.Binary

Methods

toBinRep :: String -> Either String ByteString

BinRep ByteString

Bytestrings are copied as-is.

Defined in StreamPatch.Patch.Binary

Methods

toBinRep :: ByteString -> Either String ByteString

BinRep Text

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

Defined in StreamPatch.Patch.Binary

Methods

toBinRep :: Text -> Either String ByteString

BinRep HexByteString

Defined in BytePatch.HexByteString

Methods

toBinRep :: HexByteString -> Either String ByteString

KnownNat n => BinRep (PascalText n)

Defined in StreamPatch.Patch.Binary.PascalText

Methods

toBinRep :: PascalText n -> Either String ByteString

toBinRep' :: BinRep a => a -> Either (Error a) ByteString

check :: BinRep a => Cfg -> ByteString -> MetaStream a -> Either (Error a) ()