Safe Haskell	None
Language	Haskell2010

Data.Persist.Internal

Contents

The Get type
The Put type
Size reservations

Synopsis

data a :!: b = !a :!: !b
newtype Get a = Get {
- unGet :: GetEnv -> Ptr Word8 -> IO (Ptr Word8 :!: a)
}
data GetEnv = GetEnv {
- buf :: !(ForeignPtr Word8)
- begin :: !(Ptr Word8)
- end :: !(Ptr Word8)
- tmp :: !(Ptr Word8)
}
data GetException
- = LengthException Int String
- | CharException Int String
- | EOFException Int String
- | GenericGetException Int String
getOffset :: Get Int
failGet :: (Int -> String -> GetException) -> String -> Get a
runGet :: Get a -> ByteString -> Either String a
runGetIO :: Get a -> ByteString -> IO a
unsafeGetPrefix :: Int -> Get a -> Get a
newtype Put a = Put {
- unPut :: PutEnv -> Ptr Word8 -> IO (Ptr Word8 :!: a)
}
data PutEnv = PutEnv {
- chunks :: !(IORef (NonEmpty Chunk))
- end :: !(IORef (Ptr Word8))
- tmp :: !(Ptr Word8)
}
data PutException = PutSizeMissingStartChunk
data Chunk = Chunk {
- begin :: !(Ptr Word8)
- end :: !(Ptr Word8)
}
evalPut :: Put a -> (a, ByteString)
evalPutStrictIO :: Put a -> IO (a, ByteString)
evalPutLazy :: Put a -> (a, ByteString)
evalPutLazyIO :: Put a -> IO (a, ByteString)
grow :: Int -> Put ()
data PutSize a = PutSize {
- sizePtr :: !(Ptr Word8)
- sizeStart :: !(Ptr Word8)
- chunkStart :: !(Ptr Word8)
}

Documentation

data a :!: b infixl 2 Source #

Constructors

!a :!: !b infixl 2

The Get type

newtype Get a Source #

Constructors

Get
Fields unGet :: GetEnv -> Ptr Word8 -> IO (Ptr Word8 :!: a)

Instances

Instances details

MonadFail Get Source #
Instance details Defined in Data.Persist.Internal Methods fail :: String -> Get a #
Applicative Get Source #
Instance details Defined in Data.Persist.Internal Methods pure :: a -> Get a # (<>) :: Get (a -> b) -> Get a -> Get b # liftA2 :: (a -> b -> c) -> Get a -> Get b -> Get c # (>) :: Get a -> Get b -> Get b # (<*) :: Get a -> Get b -> Get a #
Functor Get Source #
Instance details Defined in Data.Persist.Internal Methods fmap :: (a -> b) -> Get a -> Get b # (<$) :: a -> Get b -> Get a #
Monad Get Source #
Instance details Defined in Data.Persist.Internal Methods (>>=) :: Get a -> (a -> Get b) -> Get b # (>>) :: Get a -> Get b -> Get b # return :: a -> Get a #

data GetEnv Source #

Constructors

GetEnv
Fields buf :: !(ForeignPtr Word8) begin :: !(Ptr Word8) end :: !(Ptr Word8) tmp :: !(Ptr Word8)

data GetException Source #

Constructors

LengthException Int String
CharException Int String
EOFException Int String
GenericGetException Int String

Instances

Instances details

Exception GetException Source #
Instance details Defined in Data.Persist.Internal Methods toException :: GetException -> SomeException # fromException :: SomeException -> Maybe GetException # displayException :: GetException -> String #
Show GetException Source #
Instance details Defined in Data.Persist.Internal Methods showsPrec :: Int -> GetException -> ShowS # show :: GetException -> String # showList :: [GetException] -> ShowS #
Eq GetException Source #
Instance details Defined in Data.Persist.Internal Methods (==) :: GetException -> GetException -> Bool # (/=) :: GetException -> GetException -> Bool #

getOffset :: Get Int Source #

failGet :: (Int -> String -> GetException) -> String -> Get a Source #

runGet :: Get a -> ByteString -> Either String a Source #

Run the Get monad applies a get-based parser on the input ByteString

runGetIO :: Get a -> ByteString -> IO a Source #

unsafeGetPrefix :: Int -> Get a -> Get a Source #

The Put type

newtype Put a Source #

Constructors

Put
Fields unPut :: PutEnv -> Ptr Word8 -> IO (Ptr Word8 :!: a)

Instances

Instances details

Applicative Put Source #
Instance details Defined in Data.Persist.Internal Methods pure :: a -> Put a # (<>) :: Put (a -> b) -> Put a -> Put b # liftA2 :: (a -> b -> c) -> Put a -> Put b -> Put c # (>) :: Put a -> Put b -> Put b # (<*) :: Put a -> Put b -> Put a #
Functor Put Source #
Instance details Defined in Data.Persist.Internal Methods fmap :: (a -> b) -> Put a -> Put b # (<$) :: a -> Put b -> Put a #
Monad Put Source #
Instance details Defined in Data.Persist.Internal Methods (>>=) :: Put a -> (a -> Put b) -> Put b # (>>) :: Put a -> Put b -> Put b # return :: a -> Put a #

data PutEnv Source #

Constructors

PutEnv
Fields chunks :: !(IORef (NonEmpty Chunk)) end :: !(IORef (Ptr Word8)) tmp :: !(Ptr Word8)

data PutException Source #

Constructors

PutSizeMissingStartChunk

Instances

Instances details

Exception PutException Source #
Instance details Defined in Data.Persist.Internal Methods toException :: PutException -> SomeException # fromException :: SomeException -> Maybe PutException # displayException :: PutException -> String #
Show PutException Source #
Instance details Defined in Data.Persist.Internal Methods showsPrec :: Int -> PutException -> ShowS # show :: PutException -> String # showList :: [PutException] -> ShowS #
Eq PutException Source #
Instance details Defined in Data.Persist.Internal Methods (==) :: PutException -> PutException -> Bool # (/=) :: PutException -> PutException -> Bool #

data Chunk Source #

Constructors

Chunk
Fields begin :: !(Ptr Word8) end :: !(Ptr Word8)

evalPut :: Put a -> (a, ByteString) Source #

evalPutStrictIO :: Put a -> IO (a, ByteString) Source #

evalPutLazy :: Put a -> (a, ByteString) Source #

evalPutLazyIO :: Put a -> IO (a, ByteString) Source #

grow :: Int -> Put () Source #

Ensure that n bytes can be written.

Size reservations

data PutSize a Source #

Constructors

PutSize
Fields sizePtr :: !(Ptr Word8) sizeStart :: !(Ptr Word8) chunkStart :: !(Ptr Word8)