• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[#parser]
2[section Parser]
3
4A ['parser] is a [link metafunction_class template metafunction class] that
5takes the following arguments:
6
7* a suffix of the input text, a [link string `string`]
8* a [link source_position source position] describing at which position of the
9  entire input text the suffix begins at
10
11The function parses a prefix of the input string.
12When the parsing is successful, it returns an [link accept `accept`] value.
13When there is a parsing error, the parser returns a [link reject `reject`]
14value. The [link is_error `is_error`] metafunction can be used to determine
15about the result of a parser if it succeeded or failed.
16
17The documentation refers often to the ['result of a parser]. This means that the
18parser accepts the input and refers to what [link get_result `get_result`]
19returns for the value returned by the parser.
20
21[endsect]
22
23