Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.ProtoLens.Encoding.Bytes

Contents

Running encodings
Bytestrings
Text
Integral types
Floating-point types
Signed types
Other utilities

Description

Utility functions for parsing and encoding individual types.

Synopsis

data Parser a
data Builder
runParser :: Parser a -> ByteString -> Either String a
isolate :: Int -> Parser a -> Parser a
runBuilder :: Builder -> ByteString
getBytes :: Int -> Parser ByteString
putBytes :: ByteString -> Builder
getText :: Int -> Parser Text
getVarInt :: Parser Word64
getVarIntH :: Handle -> ExceptT String IO Word64
putVarInt :: Word64 -> Builder
getFixed32 :: Parser Word32
getFixed64 :: Parser Word64
putFixed32 :: Word32 -> Builder
putFixed64 :: Word64 -> Builder
wordToFloat :: Word32 -> Float
wordToDouble :: Word64 -> Double
floatToWord :: Float -> Word32
doubleToWord :: Double -> Word64
signedInt32ToWord :: Int32 -> Word32
wordToSignedInt32 :: Word32 -> Int32
signedInt64ToWord :: Int64 -> Word64
wordToSignedInt64 :: Word64 -> Int64
atEnd :: Parser Bool
runEither :: Either String a -> Parser a
(<?>) :: Parser a -> String -> Parser a
foldMapBuilder :: Vector v a => (a -> Builder) -> v a -> Builder

Running encodings

data Parser a Source #

A monad for parsing an input buffer.

Instances

Instances details

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

data Builder #

Builders denote sequences of bytes. They are Monoids where mempty is the zero-length sequence and mappend is concatenation, which runs in O(1).

Instances

Instances details

Monoid Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods mempty :: Builder # mappend :: Builder -> Builder -> Builder # mconcat :: [Builder] -> Builder #
Semigroup Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods (<>) :: Builder -> Builder -> Builder # sconcat :: NonEmpty Builder -> Builder # stimes :: Integral b => b -> Builder -> Builder #

runParser :: Parser a -> ByteString -> Either String a Source #

Evaluates a parser on the given input.

If the parser does not consume all of the input, the rest of the input is discarded and the parser still succeeds. Parsers may use atEnd to detect whether they are at the end of the input.

Values returned from actions in this monad will not hold onto the original ByteString, but rather make immutable copies of subsets of its bytes.

isolate :: Int -> Parser a -> Parser a Source #

Run the given parsing action as if there are only len bytes remaining. That is, once len bytes have been consumed, atEnd will return True and other actions like getWord8 will act like there is no input remaining.

Fails the parse if given a negative length.

runBuilder :: Builder -> ByteString Source #

Constructs a strict ByteString from the given Builder.

Bytestrings

getBytes :: Int -> Parser ByteString Source #

Parse a sequence of zero or more bytes of the given length.

The new ByteString is an immutable copy of the bytes in the input and will be managed separately on the Haskell heap from the original input ByteString.

Fails the parse if given a negative length.

putBytes :: ByteString -> Builder Source #

Emit a given ByteString.