Copyright | Bryan O'Sullivan 2011 |
---|---|
License | BSD3 |
Maintainer | bos@serpentine.com |
Stability | experimental |
Portability | unknown |
Safe Haskell | None |
Language | Haskell98 |
Data.Attoparsec.Types
Description
Simple, efficient parser combinators for strings, loosely based on the Parsec library.
- data Parser t a
- data IResult t r
- class Monoid c => Chunk c where
- type ChunkElem c
- nullChunk :: c -> Bool
- unsafeChunkHead :: c -> ChunkElem c
- unsafeChunkTail :: c -> c
- chunkLengthAtLeast :: c -> Int -> Bool
- chunkElemToChar :: c -> ChunkElem c -> Char
Documentation
The core parser type. This is parameterised over the type t
of
string being processed.
This type is an instance of the following classes:
Monad
, wherefail
throws an exception (i.e. fails) with an error message.Functor
andApplicative
, which follow the usual definitions.MonadPlus
, wheremzero
fails (with no error message) andmplus
executes the right-hand parser if the left-hand one fails. When the parser on the right executes, the input is reset to the same state as the parser on the left started with. (In other words, Attoparsec is a backtracking parser that supports arbitrary lookahead.)Alternative
, which followsMonadPlus
.
The result of a parse. This is parameterised over the type t
of string that was processed.
This type is an instance of Functor
, where fmap
transforms the
value in a Done
result.
Constructors
Fail t [String] String | The parse failed. The |
Partial (t -> IResult t 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 t r | The parse succeeded. The |
class Monoid c => Chunk c where Source
A common interface for input chunks.
Methods
Test if the chunk is empty.
unsafeChunkHead :: c -> ChunkElem c Source
Get the head element of a non-empty chunk.
unsafeChunkTail :: c -> c Source
Get the tail of a non-empty chunk.
chunkLengthAtLeast :: c -> Int -> Bool Source
Check if the chunk has the length of at least n
elements.
chunkElemToChar :: c -> ChunkElem c -> Char Source
Map an element to the corresponding character. The first argument is ignored.
Instances