Ptr.Read

Documentation

data Read a

Deserializer highly optimized for reading from pointers.

Parsing ByteString is just a special case.

Instances

Monad Read

Defined in Ptr.Read

Methods

(>>=) :: Read a -> (a -> Read b) -> Read b

(>>) :: Read a -> Read b -> Read b

return :: a -> Read a

Functor Read

Defined in Ptr.Read

Methods

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

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

Applicative Read

Defined in Ptr.Read

Methods

pure :: a -> Read a

(<*>) :: Read (a -> b) -> Read a -> Read b

liftA2 :: (a -> b -> c) -> Read a -> Read b -> Read c

(*>) :: Read a -> Read b -> Read b

(<*) :: Read a -> Read b -> Read a

data Status a

Result of a single iteration.

Errors can be achieved by using Either for output.

Constructors

FinishedStatus !(Ptr Word8) a

UnfinishedStatus (Read a)

Instances

Functor Status

Defined in Ptr.Read

Methods

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

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

runOnPtr :: Read a -> Ptr Word8 -> Ptr Word8 -> IO (Status a)

runOnByteString :: Read a -> ByteString -> Either (Read a) (a, ByteString)

runOnByteStringFinishing :: Read a -> ByteString -> Maybe a

skip

Arguments

:: Int

Amount of bytes to skip.

Warning: It is your responsibility to ensure that it is not negative.

-> Read ()

skipWhile :: (Word8 -> Bool) -> Read ()

byteString

Arguments

:: Int

Size of the bytestring.

Warning: It is your responsibility to ensure that it is not negative.

-> Read ByteString

byteStringWhile :: (Word8 -> Bool) -> Read ByteString

foldlWhile' :: (Word8 -> Bool) -> (acc -> Word8 -> acc) -> acc -> Read acc

word8 :: Read Word8

int16InBe :: Read Int16

int32InBe :: Read Int32

int64InBe :: Read Int64

nullTerminatedByteString :: Read ByteString

asciiIntegral :: Integral a => Read a

Integral number encoded in ASCII.