.\" 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 "Net::GitHub::V3::ResultSet 3pm"
.TH Net::GitHub::V3::ResultSet 3pm "2022-10-08" "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"
Net::GitHub::V3::ResultSet \- GitHub query iteration helper
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
For use by the role Net::GitHub::V3::Query:
.PP
.Vb 1
\&    use Net::GitHub::V3::ResultSet;
\&
\&    $result_set = Net::GitHub::V3::ResultSet\->new( url => $url );
\&    ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects in this class store the current status of a GitHub query while
the user iterates over individual items.  This happens behind the
scenes, users of Net::GitHub::V3 don't need to know about this class.
.PP
Each of the V3 submodules holds one of these objects for every
different pageable query which it handles.
.PP
The attributes have the following function:
.IP "url" 4
.IX Item "url"
Required for creating the object: This is the \s-1URL\s0 where a pageable
GitHub query starts, and this \s-1URL\s0 will be used to identify the
pagination when retrieving the next object, and also for the first
call to the GitHub \s-1API.\s0
.IP "results" 4
.IX Item "results"
An array reference holding the current page as retrieved by the most
recent call to the GitHub \s-1API.\s0
.IP "cursor" 4
.IX Item "cursor"
An integer pointing to the \*(L"next\*(R" position within the current page
from which the next method will fetch an item.
.IP "done" 4
.IX Item "done"
A boolean indicating that there's no more item to be fetched from the
\&\s-1API:\s0 The current results are the last.
.IP "next_url" 4
.IX Item "next_url"
The url from which more results can be fetched.  Will be empty if
there are no more pages.