Data.Binary.Get.Internal · binary-0.8.9.3

The Get type

6 declarations

newtypenewtype Get a

#

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Functor GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
MonadFail GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Applicative GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Alternative GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
MonadPlus GetDefined in binary-0.8.9.3 · Data.Binary.Get.Internal

valuerunCont :: Get a -> forall r. ByteString -> Success a r -> Decoder r

#

datadata Decoder a

#

A decoder produced by running a Get monad.

Constructors

Fail !ByteString String
The decoder ran into an error. The decoder either used fail or was not provided enough input.
Partial (Maybe ByteString -> Decoder a)
The decoder has consumed the available input and needs more to continue. Provide Just if more input is available and Nothing otherwise, and you will get a new Decoder.
Done !ByteString a
The decoder has successfully finished. Except for the output value you also get the unused input.
BytesRead !Int64 (Int64 -> Decoder a)
The decoder needs to know the current position in the input. Given the number of bytes remaning in the decoder, the outer decoder runner needs to calculate the position and resume the decoding.

Instances2Functor, Show

Functor DecoderDefined in binary-0.8.9.3 · Data.Binary.Get.Internal
Show a => Show (Decoder a)Defined in binary-0.8.9.3 · Data.Binary.Get.Internal

valuerunGetIncremental :: Get a -> Decoder a

#

Run a Get monad. See Decoder for what to do next, like providing input, handling decoding errors and to get the output value.

valuereadN :: Int -> (ByteString -> a) -> Get a

#

Return at least n bytes, maybe more. If not enough data is available the computation will escape with Partial.

valuereadNWith :: Int -> (Ptr a -> IO a) -> Get a

#

readNWith n f where f must be deterministic and not have side effects.

Parsing

2 declarations

valuebytesRead :: Get Int64

#

Get the total number of bytes read to this point.

valueisolate

:: Int
The number of bytes that must be consumed
-> Get a
The decoder to isolate
-> Get a

#

Isolate a decoder to operate with a fixed number of bytes, and fail if fewer bytes were consumed, or more bytes were attempted to be consumed. If the given decoder fails, isolate will also fail. Offset from bytesRead will be relative to the start of isolate, not the absolute of the input.

With input chunks

6 declarations

valuewithInputChunks

:: s
-> Consume s
-> [ByteString] -> b
-> [ByteString] -> Get b
-> Get b

#

typetype Consume s = s -> ByteString -> Either s (ByteString, ByteString)

#

valuefailOnEOF :: [ByteString] -> Get a

#

valueget :: Get ByteString

#

Get the current chunk.

valueput :: ByteString -> Get ()

#

Replace the current chunk.

valueensureN :: Int -> Get ()

#

Ensure that there are at least n bytes available. If not, the computation will escape with Partial.

Utility

7 declarations

valueremaining :: Get Int64

#

Deprecated. This will force all remaining input, don't use it.

DEPRECATED. Get the number of bytes of remaining input. Note that this is an expensive function to use as in order to calculate how much input remains, all input has to be read and kept in-memory. The decoder keeps the input as a strict bytestring, so you are likely better off by calculating the remaining input in another way.

valuegetBytes :: Int -> Get ByteString

#

Deprecated. Use getByteString instead of getBytes.

DEPRECATED. Same as getByteString.

valueisEmpty :: Get Bool

#

Test whether all input has been consumed, i.e. there are no remaining undecoded bytes.

valuelookAhead :: Get a -> Get a

#

Run the given decoder, but without consuming its input. If the given decoder fails, then so will this function.

valuelookAheadM :: Get (Maybe a) -> Get (Maybe a)

#

Run the given decoder, and only consume its input if it returns Just. If Nothing is returned, the input will be unconsumed. If the given decoder fails, then so will this function.

valuelookAheadE :: Get (Either a b) -> Get (Either a b)

#

Run the given decoder, and only consume its input if it returns Right. If Left is returned, the input will be unconsumed. If the given decoder fails, then so will this function.

valuelabel :: String -> Get a -> Get a

#

Label a decoder. If the decoder fails, the label will be appended on a new line to the error message string.

ByteStrings

valuegetByteString :: Int -> Get ByteString

#

An efficient get method for strict ByteStrings. Fails if fewer than n bytes are left in the input. If n <= 0 then the empty string is returned.