GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulecereal-0.5.8.3Haskell2010
The Get monad. A monad for efficiently building structures from strict ByteStrings
The Get monad is an Exception and State monad.
Monad GetDefined in cereal-0.5.8.3 · Data.Serialize.GetFunctor GetDefined in cereal-0.5.8.3 · Data.Serialize.GetMonadFail GetDefined in cereal-0.5.8.3 · Data.Serialize.GetApplicative GetDefined in cereal-0.5.8.3 · Data.Serialize.GetAlternative GetDefined in cereal-0.5.8.3 · Data.Serialize.GetMonadPlus GetDefined in cereal-0.5.8.3 · Data.Serialize.GetRun the Get monad applies a get-based parser on the input ByteString
Run the Get monad over a Lazy ByteString. Note that this will not run the Get parser lazily, but will operate on lazy ByteStrings.
Run the Get monad applies a get-based parser on the input
ByteString, starting at the specified offset. In addition to the result of get
it returns the rest of the input.
Run the Get monad over a Lazy ByteString. Note that this does not run the Get parser lazily, but will operate on lazy ByteStrings.
The result of a parse.
Fail String ByteStringThe parse failed. The String is the message describing the error, if any.
Partial (ByteString -> Result r)Supply this continuation with more input so that the parser can resume. To indicate that no more input is available, use an empty string.
Done r ByteStringThe parse succeeded. The ByteString is the input that had not yet been consumed (if any) when the parse succeeded.
Run the Get monad applies a get-based parser on the input ByteString
Run the get monad on a single chunk, providing an optional length for the remaining, unseen input, with Nothing indicating that it's not clear how much input is left. For example, with a lazy ByteString, the optional length represents the sum of the lengths of all remaining chunks.
If at least n bytes of input are available, return the current
input, otherwise fail.
Isolate an action to operating within a fixed block of bytes. The action is required to consume all the bytes that it is isolated to.
Skip ahead n bytes. Fails if fewer than n bytes are available.
Skip ahead up to n bytes in the current chunk. No error if there aren't
enough bytes, or if less than n bytes are skipped.
Run ga, but return without consuming its input.
Fails if ga fails.
Like lookAhead, but consume the input if gma returns 'Just _'.
Fails if gma fails.
Like lookAhead, but consume the input if gea returns 'Right _'.
Fails if gea fails.
Get the next up to n bytes as a ByteString until end of this chunk,
without consuming them.
Get the number of bytes read up to this point
Pull n bytes from the input, as a strict ByteString.
Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed.
WARNING: when run with runGetPartial, remaining will only return the number
of bytes that are remaining in the current input.
Test whether all input has been consumed.
WARNING: when run with runGetPartial, isEmpty will only tell you if you're
at the end of the current chunk.
Read a Word8 from the monad state
Read a Int8 from the monad state
An efficient get method for strict ByteStrings. Fails if fewer
than n bytes are left in the input. This function creates a fresh
copy of the underlying bytes.
Read a Word16 in big endian format
Read a Word32 in big endian format
Read a Word64 in big endian format
Read a Int16 in big endian format
Read a Int32 in big endian format
Read a Int64 in big endian format
Read a Word16 in little endian format
Read a Word32 in little endian format
Read a Word64 in little endian format
Read a Int16 in little endian format
Read a Int32 in little endian format
Read a Int64 in little endian format
O(1). Read a single native machine word. The word is read in host order, host endian form, for the machine you're on. On a 64 bit machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes.
O(1). Read a 2 byte Word16 in native host order and host endianness.
O(1). Read a Word32 in native host order and host endianness.
O(1). Read a Word64 in native host order and host endianness.
Get a list in the following format: Word64 (big endian format) element 1 ... element n
Get an IArray in the following format: index (lower bound) index (upper bound) Word64 (big endian format) element 1 ... element n
Read as a list of lists.
Get a sequence in the following format: Word64 (big endian format) element 1 ... element n
Read as a list of pairs of key and element.
Read as a list of pairs of int and element.
Read as a list of elements.
Read as a list of ints.
Read in a Maybe in the following format: Word8 (0 for Nothing, anything else for Just) element (when Just)
Read an Either, in the following format: Word8 (0 for Left, anything else for Right) element a when 0, element b otherwise
Read in a length and then read a nested structure of that length.