.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "MakeMethods::Template::StructBuiltin 3pm"
.TH MakeMethods::Template::StructBuiltin 3pm "2016-06-10" "perl v5.22.2" "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"
Class::MakeMethods::Template::StructBuiltin \- generates a wrapper around some builtin function
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&  use Class::MakeMethods::Template::StructBuiltin (
\&    \-TargetClass => \*(AqMyStat\*(Aq,
\&    builtin_isa => [ 
\&      \*(Aq\-{new_function}\*(Aq=>\*(Aqstat\*(Aq, 
\&        qw/ dev ino mode nlink / 
\&    ]
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class generates a wrapper around some builtin function,
storing the results in the object and providing a by-name interface.
.PP
Takes a (core) function name, and a arrayref of return position names
(we will call it pos_list).  Creates:
.IP "new" 4
.IX Item "new"
Calls the core func with any given arguments, stores the result in the
instance.
.IP "x" 4
.IX Item "x"
For each member of pos_list, creates a method of the same name which
gets/sets the nth member of the returned list, where n is the position
of x in pos_list.
.IP "fields" 4
.IX Item "fields"
Returns pos_list, in the given order.
.IP "dump" 4
.IX Item "dump"
Returns a list item name, item value, in order.
.PP
Example Usage:
.PP
.Vb 1
\&  package Stat;
\&
\&  use Class::MakeMethods::Template::StructBuiltin
\&    builtin_isa => [ \*(Aq\-{new_function}\*(Aq=>\*(Aqstat\*(Aq, qw/ dev ino mode nlink / ],
\&
\&  package main;
\&
\&  my $file = "$ENV{HOME}/.template";
\&  my $s = Stat\->new($file);
\&  print "File $file has ", $s\->nlink, " links\en";
.Ve
.PP
Note that (a) the new method does not check the return value of the
function called (in the above example, if \f(CW$file\fR does not exist, you will
silently get an empty object), and (b) if you really want the above
example, see the core File::stat module.   But you get the idea, I hope.