.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "Parse.ParseState" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
Parse::ParseState \- The current state of the string being parsed.
.SH "SYNOPSIS"
.B Parse::ParseState<
\fI\fP
.B >
.IP "" -2
= 
.BI "ParseState(" "Int line,Int pos,String input" ")"
.SH "DESCRIPTION"
.PP
This data type represents the current state of the parsing.
\fBline \fP
and
\fBpos \fP
represent the current position of the parser with respect to the original String (both starting at 1), and
\fBinput \fP
contains the unparsed section of the String.
.PP
The constructors are public for ease of inspection and to allow users to write their own parser functions, but should never be altered directly outside a parse function.
.PP
When writing your own parser, use
.B "Strings.behead"(3kaya)
and
.B "Strings.ltruncate"(3kaya)
to efficiently remove parsed characters from the string.
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
.SH "RELATED"
.PD 0
.PP
.B "Parse.initial"(3kaya)
.PD 0.4v