.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "DR::Tarantool::Tuple::MsgPack 3pm"
.TH DR::Tarantool::Tuple::MsgPack 3pm "2019-10-07" "perl v5.30.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"
DR::Tarantool::Tuple::MsgPack \- a tuple container for DR::Tarantool (v >= 1.6)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    my $tuple = new DR::Tarantool::Tuple::MsgPack::MsgPack([ 1, 2, 3]);
\&    my $tuple = new DR::Tarantool::Tuple::MsgPack::MsgPack([ 1, 2, 3], $space);
\&    my $tuple = unpack DR::Tarantool::Tuple::MsgPack::MsgPack([ 1, 2, 3], $space);
\&
\&
\&    $tuple\->next( $other_tuple );
\&
\&    $f = $tuple\->raw(0);
\&
\&    $f = $tuple\->name_field;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A tuple contains normalized (unpacked) fields. You can access the fields
by their indexes (see raw function) or by their names (if they are
described in the space).
.PP
Each tuple can contain references to next tuple and iterator,
so that if the server returns more than one tuple, all of them
can be accessed.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
A constructor.
.PP
.Vb 2
\&    my $t = DR::Tarantool::Tuple::MsgPack\->new([1, 2, 3]);
\&    my $t = DR::Tarantool::Tuple::MsgPack\->new([1, 2, 3], $space);
.Ve
.SS "unpack"
.IX Subsection "unpack"
Another way to construct a tuple.
.PP
.Vb 1
\&    my $t = DR::Tarantool::Tuple::MsgPack\->unpack([1, 2, 3], $space);
.Ve
.SS "raw"
.IX Subsection "raw"
Return raw data from the tuple.
.PP
.Vb 1
\&    my $array = $tuple\->raw;
\&
\&    my $field = $tuple\->raw(0);
.Ve
.SS "next"
.IX Subsection "next"
Append or return the next tuple, provided there is more than one
tuple in the result set.
.PP
.Vb 1
\&    my $next_tuple = $tuple\->next;
.Ve
.SS "iter"
.IX Subsection "iter"
Return an iterator object associated with the tuple.
.PP
.Vb 1
\&    my $iterator = $tuple\->iter;
\&
\&    my $iterator = $tuple\->iter(\*(AqMyTupleClass\*(Aq, \*(Aqnew\*(Aq);
\&
\&    while(my $t = $iterator\->next) {
\&        # the first value of $t and $tuple are the same
\&        ...
\&    }
.Ve
.PP
\fIArguments\fR
.IX Subsection "Arguments"
.IP "package (optional)" 4
.IX Item "package (optional)"
.PD 0
.IP "method (optional)" 4
.IX Item "method (optional)"
.PD
If 'package' and 'method' are present, \f(CW$iterator\fR\->next method
constructs objects using \f(CW\*(C`$package\->$method( $next_tuple )\*(C'\fR
.Sp
If 'method' is not present and 'package' is present, the iterator
blesses the  raw array with 'package'.
.SS "tail"
.IX Subsection "tail"
Return the tail of the tuple (array of unnamed fields). The function always
returns \fB\s-1ARRAYREF\s0\fR (as raw).
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 2
\& Copyright (C) 2011 Dmitry E. Oboukhov <unera@debian.org>
\& Copyright (C) 2011 Roman V. Nikolaev <rshadow@rambler.ru>
\&
\& This program is free software, you can redistribute it and/or
\& modify it under the terms of the Artistic License.
.Ve
.SH "VCS"
.IX Header "VCS"
The project is placed git repo on github:
<https://github.com/dr\-co/dr\-tarantool/>.