Simple parsing result, that represent respectively:

• Success: the remaining unparsed data and the parsed value
• Failure: the remaining unparsed data and the error message
• Partial: that need for more input data, supply empty bytes to indicate endOfInput

Type alias for error message

Simple CPSed parser

A parser takes a failure continuation, and a success one, while the success continuation is usually composed by Monad instance, the failure one is more like a reader part, which can be modified via <?>. If you build parsers from ground, a pattern like this can be used:

   xxParser = do
     ensureN errMsg ...            -- make sure we have some bytes
     Parser $  kf k s inp ->      -- fail continuation, success continuation, state token and input
       ...
       ... kf errMsg (if input not OK)
       ... k s ... (if we get something useful for next parser)
 

Parse the complete input, without resupplying, return the rest bytes

Parse the complete input, without resupplying

Parse an input chunk

Type alias for a streaming parser, draw chunk from Monad m with a initial chunk, return result in Either err x.

Run a chunk parser with an initial input string, and a monadic action that can supply more input if needed.

Finish parsing and fetch result, feed empty bytes if it's Partial result.

Run a parser and keep track of all the input chunks it consumes. Once it's finished, return the final result (always Success or Failure) and all consumed chunks.

Return both the result of a parse and the portion of the input that was consumed while it was being parsed.

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

Since this parser is used in many other parsers, an extra error param is provide to attach custom error info.

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

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

Get current input chunk, draw new chunk if neccessary. null means EOF.

Note this is different from takeRemaining, currentChunk only return what's left in current input chunk.

Decode a primitive type in host byte order.

big endianess wrapper

little endianess wrapper

Decode a primitive type in little endian.

Decode a primitive type in big endian.

A stateful scanner. The predicate consumes and transforms a state argument, and each transformed state is passed to successive invocations of the predicate on each byte of the input until one returns Nothing or the input ends.

This parser does not fail. It will return an empty string if the predicate returns Nothing on the first byte of input.

Similar to scan, but working on Bytes chunks, The predicate consumes a Bytes chunk and transforms a state argument, and each transformed state is passed to successive invocations of the predicate on each chunk of the input until one chunk got splited to Right (V.Bytes, V.Bytes) or the input ends.

Match any byte, to perform lookahead. Returns Nothing if end of input has been reached. Does not consume any input.

Match any byte, to perform lookahead. Does not consume any input, but will fail if end of input has been reached.

The parser satisfy p succeeds for any byte for which the predicate p returns True. Returns the byte that is actually parsed.

digit = satisfy isDigit
    where isDigit w = w >= 48 && w <= 57

The parser satisfyWith f p transforms a byte, and succeeds if the predicate p returns True on the transformed value. The parser returns the transformed byte that was parsed.

Return a byte, this is an alias to decodePrim Word8@.

Match a specific byte.

Match a specific 8bit char.

Take a byte and return as a 8bit char.

Decode next few bytes as an UTF8 char.

Don't use this method as UTF8 decoder, it's slower than validate.

Match a specific UTF8 char.

Match a specific 7bit char.

Take a byte and return as a 7bit char, fail if exceeds 0x7F.

Skip a byte.

Match either a single newline byte '\n', or a carriage return followed by a newline byte "\r\n".

skip N bytes.

Skip past input for as long as the predicate returns True.

Skip over white space using isSpace.

Similar to take, but requires the predicate to succeed on next N bytes of input, and take N bytes(no matter if N+1 byte satisfy predicate or not).

Consume input as long as the predicate returns False or reach the end of input, and return the consumed input.

Consume input as long as the predicate returns True or reach the end of input, and return the consumed input.

Similar to takeWhile, but requires the predicate to succeed on at least one byte of input: it will fail if the predicate never returns True or reach the end of input

Take all the remaining input chunks and return as Bytes.

bytes s parses a sequence of bytes that identically match s.

Same as bytes but ignoring ASCII case.

text s parses a sequence of UTF8 bytes that identically match s.

Parse and decode an unsigned decimal number.

Will fail in case of overflow.

Parse a decimal number with an optional leading '+' or '-' sign character.

This parser will fail if overflow happens.

Parser specifically optimized for Integer.

Same with uint, but sliently cast in case of overflow.

Same with int, but sliently cast if overflow happens.

Take a single decimal digit and return as Int.

Parse and decode an unsigned hex number, fail if input length is larger than (bit_size/4). The hex digits 'a' through 'f' may be upper or lower case.

This parser does not accept a leading "0x" string, and consider sign bit part of the binary hex nibbles, e.g.

>>> parse' hex "FF" == Right (-1 :: Int8)
>>> parse' hex "7F" == Right (127 :: Int8)
>>> parse' hex "7Ft" == Right (127 :: Int8)
>>> parse' hex "7FF" == Left ["Z.Data.Parser.Numeric.hex","hex numeric number overflow"]

Same with hex, but only take as many as (bit_size/4) bytes.

>>> parse' hex "FF" == Right (-1 :: Int8)
>>> parse' hex "7F" == Right (127 :: Int8)
>>> parse' hex "7Ft" == Right (127 :: Int8)
>>> parse' hex "7FF" == Right (127 :: Int8)

Same with hex, but silently cast in case of overflow.

>>> parse' hex "FF" == Right (-1 :: Int8)
>>> parse' hex "7F" == Right (127 :: Int8)
>>> parse' hex "7Ft" == Right (127 :: Int8)
>>> parse' hex "7FF" == Right (-1 :: Int8)

Parse a rational number.

The syntax accepted by this parser is the same as for double.

Note: this parser is not safe for use with inputs from untrusted sources. An input with a suitably large exponent such as "1e1000000000" will cause a huge Integer to be allocated, resulting in what is effectively a denial-of-service attack.

In most cases, it is better to use double or scientific instead.

Parse a rational number and round to Float.

Single precision version of double.

Parse a rational number and round to Double.

This parser accepts an optional leading sign character, followed by at least one decimal digit. The syntax similar to that accepted by the read function, with the exception that a trailing '.' or 'e' not followed by a number is not consumed.

Examples with behaviour identical to read:

parse' double "3"     == ("", Right 3.0)
parse' double "3.1"   == ("", Right 3.1)
parse' double "3e4"   == ("", Right 30000.0)
parse' double "3.1e4" == ("", Right 31000.0)

parse' double ".3"    == (".3", Left ParserError)
parse' double "e3"    == ("e3", Left ParserError)

Examples of differences from read:

parse' double "3.foo" == (".foo", Right 3.0)
parse' double "3e"    == ("e",    Right 3.0)
parse' double "-3e"   == ("e",    Right -3.0)

This function does not accept string representations of "NaN" or "Infinity".

Parse a scientific number.

The syntax accepted by this parser is the same as for double.

Parse a scientific number and convert to result using a user supply function.

The syntax accepted by this parser is the same as for double.

Parse a rational number.

The syntax accepted by this parser is the same as for double'.

Note: this parser is not safe for use with inputs from untrusted sources. An input with a suitably large exponent such as "1e1000000000" will cause a huge Integer to be allocated, resulting in what is effectively a denial-of-service attack.

In most cases, it is better to use double' or scientific' instead.

Parse a rational number and round to Float using stricter grammer.

Single precision version of double'.

More strict number parsing(rfc8259).

scientific support parse 2314. and 21321exyz without eating extra dot or e via backtrack, this is not allowed in some strict grammer such as JSON, so we make an non-backtrack strict number parser separately using LL(1) lookahead. This parser also agree with read on extra dot or e handling:

parse' double "3.foo" == Left ParseError
parse' double "3e"    == Left ParseError

Leading zeros or + sign is also not allowed:

parse' double "+3.14" == Left ParseError
parse' double "0014" == Left ParseError

If you have a similar grammer, you can use this parser to save considerable time.

     number = [ minus ] int [ frac ] [ exp ]
     decimal-point = %x2E       ; .
     digit1-9 = %x31-39         ; 1-9
     e = %x65 / %x45            ; e E
     exp = e [ minus / plus ] 1*DIGIT
     frac = decimal-point 1*DIGIT

This function does not accept string representations of "NaN" or "Infinity". reference: https://tools.ietf.org/html/rfc8259#section-6

Parse a scientific number.

The syntax accepted by this parser is the same as for double'.

Parse a scientific number and convert to result using a user supply function.

The syntax accepted by this parser is the same as for double'.

Parse a date of the form [+,-]YYYY-MM-DD.

Parse a date and time, of the form YYYY-MM-DD HH:MM[:SS[.SSS]]. The space may be replaced with a T. The number of seconds is optional and may be followed by a fractional component.

Parse a time of the form HH:MM[:SS[.SSS]].

Parse a time zone, and return Nothing if the offset from UTC is zero. (This makes some speedups possible.)

Behaves as zonedTime, but converts any time zone offset into a -- UTC time.

Parse a date with time zone info. Acceptable formats:

  YYYY-MM-DD HH:MM Z
  YYYY-MM-DD HH:MM:SS Z
  YYYY-MM-DD HH:MM:SS.SSS Z

The first space may instead be a T, and the second space is optional. The Z represents UTC. The Z may be replaced with a time zone offset of the form +0000 or -08:00, where the first two digits are hours, the : is optional and the second two digits (also optional) are minutes.

Text version of fail.

Similar to fail`, but can produce error message with current input chunk.

Unsafely lifted an IO action into Parser.

This is only for debugging purpose(logging, etc). Don't mix compuation from realworld to parsing result, otherwise parsing is not deterministic.