| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Data.Binary.Get.Internal
Synopsis
- data Get a
- runCont :: Get a -> forall r. ByteString -> Success a r -> Decoder r
- data Decoder a
- = Fail !ByteString String
- | Partial (Maybe ByteString -> Decoder a)
- | Done !ByteString a
- | BytesRead !Int64 (Int64 -> Decoder a)
- runGetIncremental :: Get a -> Decoder a
- readN :: Int -> (ByteString -> a) -> Get a
- readNWith :: Int -> (Ptr a -> IO a) -> Get a
- bytesRead :: Get Int64
- isolate :: Int -> Get a -> Get a
- withInputChunks :: s -> Consume s -> ([ByteString] -> b) -> ([ByteString] -> Get b) -> Get b
- type Consume s = s -> ByteString -> Either s (ByteString, ByteString)
- failOnEOF :: [ByteString] -> Get a
- get :: Get ByteString
- put :: ByteString -> Get ()
- ensureN :: Int -> Get ()
- remaining :: Get Int64
- getBytes :: Int -> Get ByteString
- isEmpty :: Get Bool
- lookAhead :: Get a -> Get a
- lookAheadM :: Get (Maybe a) -> Get (Maybe a)
- lookAheadE :: Get (Either a b) -> Get (Either a b)
- label :: String -> Get a -> Get a
- getByteString :: Int -> Get ByteString
The Get type
A decoder produced by running a Get monad.
Constructors
| Fail !ByteString String | The decoder ran into an error. The decoder either used
|
| Partial (Maybe ByteString -> Decoder a) | The decoder has consumed the available input and needs
more to continue. Provide |
| 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. |
runGetIncremental :: Get a -> Decoder a Source #
readN :: Int -> (ByteString -> a) -> Get a Source #
Return at least n bytes, maybe more. If not enough data is available
the computation will escape with Partial.
readNWith :: Int -> (Ptr a -> IO a) -> Get a Source #
readNWith n f where f must be deterministic and not have side effects.
Parsing
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.
Since: binary-0.7.2.0
With input chunks
withInputChunks :: s -> Consume s -> ([ByteString] -> b) -> ([ByteString] -> Get b) -> Get b Source #
type Consume s = s -> ByteString -> Either s (ByteString, ByteString) Source #
failOnEOF :: [ByteString] -> Get a Source #
get :: Get ByteString Source #
Get the current chunk.
put :: ByteString -> Get () Source #
Replace the current chunk.
ensureN :: Int -> Get () Source #
Ensure that there are at least n bytes available. If not, the
computation will escape with Partial.
Utility
remaining :: Get Int64 Source #
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.
getBytes :: Int -> Get ByteString Source #
Deprecated: Use getByteString instead of getBytes.
DEPRECATED. Same as getByteString.
Test whether all input has been consumed, i.e. there are no remaining undecoded bytes.
lookAhead :: Get a -> Get a Source #
Run the given decoder, but without consuming its input. If the given decoder fails, then so will this function.
Since: binary-0.7.0.0
label :: String -> Get a -> Get a Source #
Label a decoder. If the decoder fails, the label will be appended on a new line to the error message string.
Since: binary-0.7.2.0
ByteStrings
getByteString :: Int -> Get ByteString Source #
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.