.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Statistics::R::IO::ParserState 3pm"
.TH Statistics::R::IO::ParserState 3pm "2022-02-10" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Statistics::R::IO::ParserState \- Current state of the IO parser
.SH "VERSION"
.IX Header "VERSION"
version 1.0002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Statistics::R::IO::ParserState;
\&    
\&    my $state = Statistics::R::IO::ParserState\->new(
\&        data => \*(Aqfile.rds\*(Aq
\&    );
\&    say $state\->at
\&    say $state\->next\->at;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You shouldn't create instances of this class, it exists mainly to
handle deserialization of R data files by the \f(CW\*(C`IO\*(C'\fR classes.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1ACCESSORS\s0"
.IX Subsection "ACCESSORS"
.IP "data" 4
.IX Item "data"
An array reference to the data being parsed. The constructs accepts a
scalar, which will be split into individual characters.
.IP "position" 4
.IX Item "position"
Position of the next data element to be processed.
.IP "at" 4
.IX Item "at"
Returns the element (byte) at the current \f(CW\*(C`position\*(C'\fR.
.IP "eof" 4
.IX Item "eof"
Returns true if the cursor (\f(CW\*(C`position\*(C'\fR) is at the end of the \f(CW\*(C`data\*(C'\fR.
.IP "singletons" 4
.IX Item "singletons"
An array reference in which unserialized data that should be exists as
singletons can be \*(L"stashed\*(R" by the parser for later reference.
.ie n .IP "get_singleton $id" 4
.el .IP "get_singleton \f(CW$id\fR" 4
.IX Item "get_singleton $id"
Return the singleton data object with the given \f(CW$id\fR.
.SS "\s-1MUTATORS\s0"
.IX Subsection "MUTATORS"
\&\f(CW\*(C`ParserState\*(C'\fR is intended to be immutable, so the \*(L"mutator\*(R" methods
actually return a new instance with appropriately modified values of
the attributes.
.IP "next" 4
.IX Item "next"
Returns a new ParserState instance with \f(CW\*(C`position\*(C'\fR advanced by one.
.ie n .IP "add_singleton $singleton" 4
.el .IP "add_singleton \f(CW$singleton\fR" 4
.IX Item "add_singleton $singleton"
Returns a new ParserState instance with \f(CW$singleton\fR argument
appended to the instance's \f(CW\*(C`singletons\*(C'\fR.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Instances of this class are intended to be immutable. Please do not
try to change their value or attributes.
.PP
There are no known bugs in this module. Please see
Statistics::R::IO for bug reporting.
.SH "SUPPORT"
.IX Header "SUPPORT"
See Statistics::R::IO for support and contact information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Davor Cubranic <cubranic@stat.ubc.ca>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2017 by University of British Columbia.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve